Class TaskuraiStepContext

Step context

Assembly: Taskurai.Worker.dll

Declaration

public class TaskuraiStepContext : IDisposable

Implements:
System.IDisposable

Properties

Step

Step response (Taskurai.Models.TaskResponse) to handle.

Declaration

public StepResponse Step { get; }

Task

Task response (Taskurai.Models.TaskResponse) to handle.

Declaration

public TaskResponse Task { get; }

State

State context Taskurai.Worker.TaskuraiStateContext.

Declaration

public TaskuraiStateContext State { get; }

CancellationToken

Either worker service has received a cancellation request or the command is timed out

Declaration

public CancellationToken CancellationToken { get; }

StaleCancellationToken

Either worker service has received a cancellation request or the step is timed out and the stale timeout is passed

Declaration

public CancellationToken StaleCancellationToken { get; }

TimeoutCancellationToken

Max duration or step timeout.

Declaration

public CancellationToken TimeoutCancellationToken { get; }

Methods

Dispose()

Dispose

Declaration

public void Dispose()

Succeeded()

Returns a succeeded result.

Declaration

public StepCommandResult Succeeded()

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult### Succeeded(ResultResponse) Returns a succeeded result with a step result.

Declaration

public StepCommandResult Succeeded(ResultResponse result)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.

Succeeded(ResultOutput)

Returns a succeeded result with a step result output.

Declaration

public StepCommandResult Succeeded(ResultOutput resultOutput)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.ResultOutput	resultOutput	Task result output Taskurai.Models.ResultOutput.

Succeeded(ValueData<object>)

Returns a succeeded result with a value data.

Declaration

public StepCommandResult Succeeded(ValueData<object> value)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.ValueData<T>	value	Task result value Taskurai.Models.ValueData%601.

Succeeded(Progress, ResultResponse, Error)

Returns a succeeded result with optional progress, result, error, and archived status.

Declaration

public StepCommandResult Succeeded(Progress progress = null, ResultResponse result = null, Error error = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.

Succeeded(int, Progress, ResultResponse, Error)

Returns a succeeded result with a status code and optional progress, result, error, and archived status.

Declaration

public StepCommandResult Succeeded(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Int32	statusCode	Additional status code to return.
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.

Succeeded(HttpStatusCode, Progress, ResultResponse, Error)

Returns a succeeded result with a HTTP status code and optional progress, result, error, and archived status.

Declaration

public StepCommandResult Succeeded(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Net.HttpStatusCode	statusCode	HTTP status code System.Net.HttpStatusCode.
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.

IntermediateFailure()

Returns an intermediate failure result.

Declaration

public StepCommandResult IntermediateFailure()

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult### IntermediateFailure(string) Returns an intermediate failure result with an error message.

Declaration

public StepCommandResult IntermediateFailure(string errorMessage)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.String	errorMessage	Task error message.

IntermediateFailure(Error)

Returns an intermediate failure result with an error.

Declaration

public StepCommandResult IntermediateFailure(Error error)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.

IntermediateFailure(Progress, ResultResponse, Error, After)

Returns an intermediate failure result with optional progress, result, error, and archived status.

Declaration

public StepCommandResult IntermediateFailure(Progress progress = null, ResultResponse result = null, Error error = null, After retryAfter = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.
Taskurai.Models.After	retryAfter	Retry failed step after Taskurai.Models.After.

IntermediateFailure(int, Progress, ResultResponse, Error, After)

Returns an intermediate failure result with a status code and optional progress, result, error, and archived status.

Declaration

public StepCommandResult IntermediateFailure(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null, After retryAfter = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Int32	statusCode	Additional status code to return.
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.
Taskurai.Models.After	retryAfter	Retry failed step after Taskurai.Models.After.

IntermediateFailure(HttpStatusCode, Progress, ResultResponse, Error, After)

Returns an intermediate failure result with a HTTP status code and optional progress, result, error, and archived status.

Declaration

public StepCommandResult IntermediateFailure(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null, After retryAfter = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Net.HttpStatusCode	statusCode	HTTP status code System.Net.HttpStatusCode.
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.
Taskurai.Models.After	retryAfter	Retry failed step after Taskurai.Models.After.

Failed()

Returns a failed result.

Declaration

public StepCommandResult Failed()

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult### Failed(string) Returns a failed result with an error message.

Declaration

public StepCommandResult Failed(string errorMessage)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.String	errorMessage	Task error message.

Failed(int, string)

Returns a failed result with an error message.

Declaration

public StepCommandResult Failed(int statusCode, string errorMessage)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Int32	statusCode	Additional status code to return.
System.String	errorMessage	Task error message.

Failed(HttpStatusCode, string)

Returns a failed result with an error message.

Declaration

public StepCommandResult Failed(HttpStatusCode statusCode, string errorMessage)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Net.HttpStatusCode	statusCode	Additional status code to return.
System.String	errorMessage	Task error message.

Failed(Error)

Returns a failed result with an error.

Declaration

public StepCommandResult Failed(Error error)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.

Failed(int, Error)

Returns a failed result with an error.

Declaration

public StepCommandResult Failed(int statusCode, Error error)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Int32	statusCode	Additional status code to return.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.

Failed(HttpStatusCode, Error)

Returns a failed result with an error.

Declaration

public StepCommandResult Failed(HttpStatusCode statusCode, Error error)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Net.HttpStatusCode	statusCode	Additional status code to return.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.

Failed(Progress, ResultResponse, Error, After)

Returns a failed result with optional progress, result, error, and archived status.

Declaration

public StepCommandResult Failed(Progress progress = null, ResultResponse result = null, Error error = null, After retryAfter = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.
Taskurai.Models.After	retryAfter	Retry failed step after Taskurai.Models.After.

Failed(int, Progress, ResultResponse, Error, After)

Returns a failed result with a status code and optional progress, result, error, and archived status.

Declaration

public StepCommandResult Failed(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null, After retryAfter = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Int32	statusCode	Additional status code to return.
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.
Taskurai.Models.After	retryAfter	Retry failed step after Taskurai.Models.After.

Failed(HttpStatusCode, Progress, ResultResponse, Error, After)

Returns a failed result with a HTTP status code and optional progress, result, error, and archived status.

Declaration

public StepCommandResult Failed(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null, After retryAfter = null)

Returns

Taskurai.Worker.StepCommandResult: Taskurai.Worker.StepCommandResult

Parameters

Type	Name	Description
System.Net.HttpStatusCode	statusCode	HTTP status code System.Net.HttpStatusCode.
Taskurai.Models.Progress	progress	Task progress Taskurai.Models.Progress.
Taskurai.Models.ResultResponse	result	Task result Taskurai.Models.ResultResponse.
Taskurai.Models.Error	error	Task error Taskurai.Models.Error.
Taskurai.Models.After	retryAfter	Retry failed step after Taskurai.Models.After.

Progress(double?, string)

Updates progress and sends a heartbeat.

Required scope: Data/Buildby.Taskurai/steps/update

Declaration

public StepResponse Progress(double? percentage = null, string message = null)

Returns

Taskurai.Models.StepResponse: Taskurai.Models.StepResponse

Parameters

Type	Name	Description
System.Nullable<System.Double>	percentage	Report progress % (optional).
System.String	message	Progress message (optional).

ProgressAsync(double?, string)

Updates progress and sends a heartbeat.

Required scope: Data/Buildby.Taskurai/steps/update

Declaration

public Task<StepResponse> ProgressAsync(double? percentage = null, string message = null)

Returns

System.Threading.Tasks.Task<Taskurai.Models.StepResponse>: Taskurai.Models.StepResponse

Parameters

Type	Name	Description
System.Nullable<System.Double>	percentage	Report progress % (optional).
System.String	message	Progress message (optional).

CompleteStep(StepCompleteInput)

Mark the step as completed and report the status (Succeeded, Failed, ...).

Required scope: Data/Buildby.Taskurai/steps/update

Declaration

public StepCompleteResult CompleteStep(StepCompleteInput input)

Returns

Taskurai.Worker.StepCompleteResult: Taskurai.Worker.StepCompleteResult

Parameters

Type	Name	Description
Taskurai.Models.StepCompleteInput	input	Taskurai.Models.StepCompleteInput.

CompleteStepAsync(StepCompleteInput)

Mark the step as completed and report the status (Succeeded, Failed, ...).

Required scope: Data/Buildby.Taskurai/steps/update

Declaration

public Task<StepCompleteResult> CompleteStepAsync(StepCompleteInput input)

Returns

System.Threading.Tasks.Task<Taskurai.Worker.StepCompleteResult>: Taskurai.Worker.StepCompleteResult

Parameters

Type	Name	Description
Taskurai.Models.StepCompleteInput	input	Taskurai.Models.StepCompleteInput.

Implements

• System.IDisposable