Skip to main content

LeaseWorkOutcome

Namespace: Meshmakers.Octo.Sdk.Common.Adapters

Outcome of the work a lease was granted for.

public struct LeaseWorkOutcome

Inheritance Object โ†’ ValueType โ†’ LeaseWorkOutcome
Implements IEquatable<LeaseWorkOutcome>

Remarks:

๐Ÿ”ด The output travels on the release because there is no other route (AB#4924 ยง9.9 / D4). A dedicated adapter reports it on IAdapterHub.ReportExecutionEndAsync, whose tenant and adapter come from the connection; a pool member holds a tenant-free management channel and has no such connection. Without this the borrower's leased execution would complete with an empty OutputData where its own adapter would have filled it.

Propertiesโ€‹

Successโ€‹

Whether the work item succeeded.

public bool Success { get; set; }

Property Valueโ€‹

Boolean

StatusMessageโ€‹

Human-readable outcome, carried back to the controller on the release. ๐Ÿ”ด Must never contain credential material โ€” it is logged and stored on the borrower's execution.

public string StatusMessage { get; set; }

Property Valueโ€‹

String

OutputDataโ€‹

What the pipeline declared as its result (SetPipelineExecutionResult@1), or null. Carried back on the release and written onto the borrower's execution.

public string OutputData { get; set; }

Property Valueโ€‹

String

Constructorsโ€‹

LeaseWorkOutcome(Boolean, String, String)โ€‹

Outcome of the work a lease was granted for.

public LeaseWorkOutcome(bool Success, string StatusMessage, string OutputData)

Parametersโ€‹

Success Boolean
Whether the work item succeeded.

StatusMessage String
Human-readable outcome, carried back to the controller on the release. ๐Ÿ”ด Must never contain credential material โ€” it is logged and stored on the borrower's execution.

OutputData String
What the pipeline declared as its result (SetPipelineExecutionResult@1), or null. Carried back on the release and written onto the borrower's execution.

Remarks:

๐Ÿ”ด The output travels on the release because there is no other route (AB#4924 ยง9.9 / D4). A dedicated adapter reports it on IAdapterHub.ReportExecutionEndAsync, whose tenant and adapter come from the connection; a pool member holds a tenant-free management channel and has no such connection. Without this the borrower's leased execution would complete with an empty OutputData where its own adapter would have filled it.

Methodsโ€‹

Succeeded(String, String)โ€‹

The work item ran and succeeded.

public static LeaseWorkOutcome Succeeded(string statusMessage, string outputData)

Parametersโ€‹

statusMessage String

outputData String

Returnsโ€‹

LeaseWorkOutcome

Failed(String)โ€‹

The work item ran and failed.

public static LeaseWorkOutcome Failed(string statusMessage)

Parametersโ€‹

statusMessage String

Returnsโ€‹

LeaseWorkOutcome