Class WorkerController

Taskurai command controller base class providing utility methods for result generation.

Assembly: Taskurai.Worker.dll

Declaration

public abstract class WorkerController

Properties

Logger

Logger for the controller Microsoft.Extensions.Logging.ILogger.

Declaration

protected ILogger Logger { get; }

TaskClient

Taskurai client Taskurai.TaskuraiClient.

Declaration

protected TaskuraiClient TaskClient { get; }

StepsClient

Taskurai steps client Taskurai.TaskuraiStepsClient.

Declaration

protected TaskuraiStepsClient StepsClient { get; }

StateClient

Taskurai client Taskurai.TaskuraiClient.

Declaration

protected TaskuraiStateClient StateClient { get; }

Methods

Succeeded()

Returns a succeeded result.

Declaration

public virtual TaskSucceededResult Succeeded()

Returns

Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult### Succeeded(ResultResponse) Returns a succeeded result with a task result.

Declaration

public virtual TaskSucceededResult Succeeded(ResultResponse result)

Returns

Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult

Parameters

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

Succeeded(ResultOutput)

Returns a succeeded result with a task result output.

Declaration

public virtual TaskSucceededResult Succeeded(ResultOutput resultOutput)

Returns

Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult

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 virtual TaskSucceededResult Succeeded(ValueData<object> value)

Returns

Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult

Parameters

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

Succeeded(Progress, ResultResponse, Error, bool?)

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

Declaration

public virtual TaskSucceededResult Succeeded(Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null)

Returns

Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.

Succeeded(int, Progress, ResultResponse, Error, bool?)

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

Declaration

public virtual TaskSucceededResult Succeeded(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null)

Returns

Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.

Succeeded(HttpStatusCode, Progress, ResultResponse, Error, bool?)

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

Declaration

public virtual TaskSucceededResult Succeeded(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null)

Returns

Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.

IntermediateFailure()

Returns an intermediate failure result.

Declaration

public virtual TaskIntermediateFailureResult IntermediateFailure()

Returns

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

Declaration

public virtual TaskIntermediateFailureResult IntermediateFailure(string errorMessage)

Returns

Taskurai.Worker.TaskIntermediateFailureResult: Taskurai.Worker.TaskIntermediateFailureResult

Parameters

Type	Name	Description
System.String	errorMessage	Task error message.

IntermediateFailure(Error)

Returns an intermediate failure result with an error.

Declaration

public virtual TaskIntermediateFailureResult IntermediateFailure(Error error)

Returns

Taskurai.Worker.TaskIntermediateFailureResult: Taskurai.Worker.TaskIntermediateFailureResult

Parameters

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

IntermediateFailure(Progress, ResultResponse, Error, bool?, After)

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

Declaration

public virtual TaskIntermediateFailureResult IntermediateFailure(Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskIntermediateFailureResult: Taskurai.Worker.TaskIntermediateFailureResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

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

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

Declaration

public virtual TaskIntermediateFailureResult IntermediateFailure(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskIntermediateFailureResult: Taskurai.Worker.TaskIntermediateFailureResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

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

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

Declaration

public virtual TaskIntermediateFailureResult IntermediateFailure(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskIntermediateFailureResult: Taskurai.Worker.TaskIntermediateFailureResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

Failed()

Returns a failed result.

Declaration

public virtual TaskFailedResult Failed()

Returns

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

Declaration

public virtual TaskFailedResult Failed(string errorMessage)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

Parameters

Type	Name	Description
System.String	errorMessage	Task error message.

Failed(int, string)

Returns a failed result with an error message.

Declaration

public virtual TaskFailedResult Failed(int statusCode, string errorMessage)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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 virtual TaskFailedResult Failed(HttpStatusCode statusCode, string errorMessage)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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 virtual TaskFailedResult Failed(Error error)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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 virtual TaskFailedResult Failed(int statusCode, Error error)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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 virtual TaskFailedResult Failed(HttpStatusCode statusCode, Error error)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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, bool?, After)

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

Declaration

public virtual TaskFailedResult Failed(Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

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

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

Declaration

public virtual TaskFailedResult Failed(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

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

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

Declaration

public virtual TaskFailedResult Failed(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

Fatal()

Returns a failed result.

Declaration

public virtual TaskFatalResult Fatal()

Returns

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

Declaration

public virtual TaskFatalResult Fatal(string errorMessage)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

Parameters

Type	Name	Description
System.String	errorMessage	Task error message.

Fatal(int, string)

Returns a failed result with an error message.

Declaration

public virtual TaskFatalResult Fatal(int statusCode, string errorMessage)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

Parameters

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

Fatal(HttpStatusCode, string)

Returns a failed result with an error message.

Declaration

public virtual TaskFatalResult Fatal(HttpStatusCode statusCode, string errorMessage)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

Parameters

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

Fatal(Error)

Returns a failed result with an error.

Declaration

public virtual TaskFatalResult Fatal(Error error)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

Parameters

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

Fatal(int, Error)

Returns a failed result with an error.

Declaration

public virtual TaskFatalResult Fatal(int statusCode, Error error)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

Parameters

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

Fatal(HttpStatusCode, Error)

Returns a failed result with an error.

Declaration

public virtual TaskFatalResult Fatal(HttpStatusCode statusCode, Error error)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

Parameters

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

Fatal(Progress, ResultResponse, Error, bool?, After)

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

Declaration

public virtual TaskFatalResult Fatal(Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

Fatal(int, Progress, ResultResponse, Error, bool?, After)

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

Declaration

public virtual TaskFatalResult Fatal(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

Fatal(HttpStatusCode, Progress, ResultResponse, Error, bool?, After)

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

Declaration

public virtual TaskFatalResult Fatal(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null, After retryAfter = null)

Returns

Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.
Taskurai.Models.After	retryAfter	Retry failed task after Taskurai.Models.After.

Canceled()

Returns a failed result.

Declaration

public virtual TaskCanceledResult Canceled()

Returns

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

Declaration

public virtual TaskCanceledResult Canceled(string errorMessage)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

Parameters

Type	Name	Description
System.String	errorMessage	Task error message.

Canceled(int, string)

Returns a failed result with an error message.

Declaration

public virtual TaskCanceledResult Canceled(int statusCode, string errorMessage)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

Parameters

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

Canceled(HttpStatusCode, string)

Returns a failed result with an error message.

Declaration

public virtual TaskCanceledResult Canceled(HttpStatusCode statusCode, string errorMessage)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

Parameters

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

Canceled(Error)

Returns a failed result with an error.

Declaration

public virtual TaskCanceledResult Canceled(Error error)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

Parameters

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

Canceled(int, Error)

Returns a failed result with an error.

Declaration

public virtual TaskCanceledResult Canceled(int statusCode, Error error)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

Parameters

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

Canceled(HttpStatusCode, Error)

Returns a failed result with an error.

Declaration

public virtual TaskCanceledResult Canceled(HttpStatusCode statusCode, Error error)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

Parameters

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

Canceled(Progress, ResultResponse, Error, bool?)

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

Declaration

public virtual TaskCanceledResult Canceled(Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.

Canceled(int, Progress, ResultResponse, Error, bool?)

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

Declaration

public virtual TaskCanceledResult Canceled(int statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.

Canceled(HttpStatusCode, Progress, ResultResponse, Error, bool?)

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

Declaration

public virtual TaskCanceledResult Canceled(HttpStatusCode statusCode, Progress progress = null, ResultResponse result = null, Error error = null, bool? archived = null)

Returns

Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult

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.
System.Nullable<System.Boolean>	archived	Mark the task as archived.