Class TaskuraiTaskContext
Task context
Assembly: Taskurai.Worker.dll
public class TaskuraiTaskContext : IDisposable
Implements:
System.IDisposable
Properties
State
State context Taskurai.Worker.TaskuraiStateContext.
public TaskuraiStateContext State { get; }
Task
Task response (Taskurai.Models.TaskResponse) to handle.
public TaskResponse Task { get; }
RequestedVersion
Requested version by task (null if no version specified)
public int? RequestedVersion { get; }
SelectedVersion
Selected version by task (null if no version specified)
public int? SelectedVersion { get; }
CancellationToken
Either worker service has received a cancellation request or the command is timed out
public CancellationToken CancellationToken { get; }
StaleCancellationToken
Either worker service has received a cancellation request or the command is timed out and the stale timeout is passed
public CancellationToken StaleCancellationToken { get; }
TimeoutCancellationToken
Max duration or task timeout.
public CancellationToken TimeoutCancellationToken { get; }
Methods
Dispose()
Dispose
public void Dispose()
CheckTaskExpired()
Check if task is expired (execution options notStartAfter).
public void CheckTaskExpired()
Exceptions
Taskurai.Worker.TaskExpiredException
Throws if task is expired.
Succeeded()
Returns a succeeded result.
public TaskSucceededResult Succeeded()
Returns
Taskurai.Worker.TaskSucceededResult: Taskurai.Worker.TaskSucceededResult### Succeeded(ResultResponse) Returns a succeeded result with a task result.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public TaskIntermediateFailureResult IntermediateFailure()
Returns
Taskurai.Worker.TaskIntermediateFailureResult: Taskurai.Worker.TaskIntermediateFailureResult### IntermediateFailure(string) Returns an intermediate failure result with an error message.
public 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.
public 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.
public 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.
public 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.
public 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.
public TaskFailedResult Failed()
Returns
Taskurai.Worker.TaskFailedResult: Taskurai.Worker.TaskFailedResult### Failed(string) Returns a failed result with an error message.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public TaskFatalResult Fatal()
Returns
Taskurai.Worker.TaskFatalResult: Taskurai.Worker.TaskFatalResult### Fatal(string) Returns a failed result with an error message.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public TaskCanceledResult Canceled()
Returns
Taskurai.Worker.TaskCanceledResult: Taskurai.Worker.TaskCanceledResult### Canceled(string) Returns a failed result with an error message.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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. |
AcquireLock(string, string, TimeSpan, TimeSpan, bool)
Acquire a distributed lock.
Required scope: Data/Buildby.Taskurai/locks/create.
public TaskuraiDistributedLock AcquireLock(string lockId, string owner, TimeSpan ttl, TimeSpan timeout, bool skipIsolationMode = false)
Returns
Taskurai.TaskuraiDistributedLock: Taskurai.TaskuraiDistributedLock
Parameters
| Type | Name | Description |
|---|---|---|
System.String | lockId | Lock id (only alphanumeric characters, dot, underscore and hyphens are allowed). |
System.String | owner | Owner of the lock. |
System.TimeSpan | ttl | Lock lease time-to-live. |
System.TimeSpan | timeout | Timeout, waiting to acquire lock. |
System.Boolean | skipIsolationMode | Skip isolation mode (defaults to global isolation mode). |
AcquireLockAsync(string, string, TimeSpan, TimeSpan, bool)
Acquire a distributed lock.
Required scope: Data/Buildby.Taskurai/locks/create.
public Task<TaskuraiDistributedLock> AcquireLockAsync(string lockId, string owner, TimeSpan ttl, TimeSpan timeout, bool skipIsolationMode = false)
Returns
System.Threading.Tasks.Task<Taskurai.TaskuraiDistributedLock>: Taskurai.TaskuraiDistributedLock
Parameters
| Type | Name | Description |
|---|---|---|
System.String | lockId | Lock id (only alphanumeric characters, dot, underscore and hyphens are allowed). |
System.String | owner | Owner of the lock. |
System.TimeSpan | ttl | Lock lease time-to-live. |
System.TimeSpan | timeout | Timeout, waiting to acquire lock. |
System.Boolean | skipIsolationMode | Skip isolation mode (defaults to global isolation mode). |
UpdateTask(TaskUpdateInput)
Updates a task.
Required scope: Data/Buildby.Taskurai/tasks/update
public TaskResponse UpdateTask(TaskUpdateInput input)
Returns
Taskurai.Models.TaskResponse: Taskurai.Models.TaskResponse
Parameters
| Type | Name | Description |
|---|---|---|
| Taskurai.Models.TaskUpdateInput | input | Taskurai.Models.TaskUpdateInput. |
UpdateTaskAsync(TaskUpdateInput)
Updates a task.
Required scope: Data/Buildby.Taskurai/tasks/update
public Task<TaskResponse> UpdateTaskAsync(TaskUpdateInput input)
Returns
System.Threading.Tasks.Task<Taskurai.Models.TaskResponse>: Taskurai.Models.TaskResponse
Parameters
| Type | Name | Description |
|---|---|---|
| Taskurai.Models.TaskUpdateInput | input | Taskurai.Models.TaskUpdateInput. |
Progress(double?, string, double?)
Updates progress and sends a heartbeat.
Required scope: Data/Buildby.Taskurai/tasks/update
public TaskResponse Progress(double? percentage = null, string message = null, double? commandTimeout = null)
Returns
Taskurai.Models.TaskResponse: Taskurai.Models.TaskResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.Nullable<System.Double> | percentage | Report progress % (optional). |
System.String | message | Progress message (optional). |
System.Nullable<System.Double> | commandTimeout | Replace command timeout in seconds (default 300, max 7 days), timeout in now+commandTimeout. |
ProgressAsync(double?, string, double?)
Updates progress and sends a heartbeat.
Required scope: Data/Buildby.Taskurai/tasks/update
public Task<TaskResponse> ProgressAsync(double? percentage = null, string message = null, double? commandTimeout = null)
Returns
System.Threading.Tasks.Task<Taskurai.Models.TaskResponse>: Taskurai.Models.TaskResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.Nullable<System.Double> | percentage | Report progress % (optional). |
System.String | message | Progress message (optional). |
System.Nullable<System.Double> | commandTimeout | Replace command timeout in seconds (default 300, max 7 days), timeout in now+commandTimeout. |
CompleteTask(TaskCompleteInput)
Mark the task as completed and report the status (Succeeded, Failed, ...).
Required scope: Data/Buildby.Taskurai/tasks/update
public TaskCompleteResult CompleteTask(TaskCompleteInput input)
Returns
Taskurai.Worker.TaskCompleteResult: Taskurai.Worker.TaskCompleteResult
Parameters
| Type | Name | Description |
|---|---|---|
| Taskurai.Models.TaskCompleteInput | input | Taskurai.Models.TaskCompleteInput. |
CompleteTaskAsync(TaskCompleteInput)
Mark the task as completed and report the status (Succeeded, Failed, ...).
Required scope: Data/Buildby.Taskurai/tasks/update
public Task<TaskCompleteResult> CompleteTaskAsync(TaskCompleteInput input)
Returns
System.Threading.Tasks.Task<Taskurai.Worker.TaskCompleteResult>: Taskurai.Worker.TaskCompleteResult
Parameters
| Type | Name | Description |
|---|---|---|
| Taskurai.Models.TaskCompleteInput | input | Taskurai.Models.TaskCompleteInput. |
SleepAsync(string, double, StepStyle)
Durable sleep step pauses execution of a command for a specified duration or until a specified date/time.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
public Task SleepAsync(string id, double seconds, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Double | seconds | Sleep for seconds. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
SleepAsync(string, DateTimeOffset, StepStyle)
Durable sleep step pauses execution of a command for a specified duration or until a specified date/time.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
public Task SleepAsync(string id, DateTimeOffset dateTime, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.DateTimeOffset | dateTime | Sleep until date/time. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
WaitForExternalEventAsync(string, string, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for specified event to be raised.
To raise an event, use the method TaskuraiClient.RaiseTaskEventAsync or TaskuraiClient.RaiseTaskEvent.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<ExternalEvent> WaitForExternalEventAsync(string id, string eventName, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<Taskurai.Models.ExternalEvent>: Taskurai.Models.ExternalEvent
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.String | eventName | Event name. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
WaitForExternalEventAsync<T>(string, string, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for specified event to be raised.
To raise an event, use the method TaskuraiClient.RaiseTaskEventAsync or TaskuraiClient.RaiseTaskEvent.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<T> WaitForExternalEventAsync<T>(string id, string eventName, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<<T>>: Returns event data.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.String | eventName | Event name. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
Type Parameters
T
WaitForTaskCompletionEventAsync(string, string, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for a task to be completed (Succeeded or Failed, Canceled after optional retries).
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<TaskCompletionEvent> WaitForTaskCompletionEventAsync(string id, string subTaskId, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<Taskurai.Models.TaskCompletionEvent>: Taskurai.Models.TaskCompletionEvent
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.String | subTaskId | Sub task id. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
WaitForTaskCompletionEventAsync<T>(string, string, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for a task to be completed (Succeeded or Failed, Canceled after optional retries).
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<T> WaitForTaskCompletionEventAsync<T>(string id, string subTaskId, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<<T>>: Returns task output data (only single value supported).
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.String | subTaskId | Sub task id. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
Type Parameters
T
WaitForExternalEventsAsync(string, IList<string>, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for specified events to be raised.
To raise an event, use the method TaskuraiClient.RaiseTaskEventAsync or TaskuraiClient.RaiseTaskEvent.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<ExternalEvent>> WaitForExternalEventsAsync(string id, IList<string> eventNames, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<Taskurai.Models.ExternalEvent>>: System.Collections.Generic.List%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Collections.Generic.IList<System.String> | eventNames | List of event names. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
WaitForExternalEventsAsync<T>(string, IList<string>, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for specified events to be raised.
To raise an event, use the method TaskuraiClient.RaiseTaskEventAsync or TaskuraiClient.RaiseTaskEvent.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<T>> WaitForExternalEventsAsync<T>(string id, IList<string> eventNames, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<<T>>>: Returns external event data (only event with same event data are supported), casted to specified type System.Collections.Generic.IEnumerable%601.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Collections.Generic.IList<System.String> | eventNames | List of event names. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
Type Parameters
T
WaitForTaskCompletionEventsAsync(string, string, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for specified tasks to be completed (Succeeded or Failed, Canceled after optional retries).
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<TaskCompletionEvent>> WaitForTaskCompletionEventsAsync(string id, string subTaskId, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<Taskurai.Models.TaskCompletionEvent>>: System.Collections.Generic.List%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.String | subTaskId | Sub task id. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
WaitForTaskCompletionEventsAsync<T>(string, string, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for specified tasks to be completed (Succeeded or Failed, Canceled after optional retries).
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<T>> WaitForTaskCompletionEventsAsync<T>(string id, string subTaskId, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<<T>>>: Returns task output data (only single value supported), casted to specified type System.Collections.Generic.IEnumerable%601.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.String | subTaskId | Sub task id. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
Type Parameters
T
WaitForExternalEventsAsync(string, IList<string>, IList<string>, long?, StepTrackingOptions, Func<StepResponse, Progress, bool>, Func<StepResponse, Progress, Task<bool>>, StepStyle)
Durable wait for specified event to be raised or for specified tasks to be completed (Succeeded or Failed, Canceled after optional retries).
To raise an event, use the method TaskuraiClient.RaiseTaskEventAsync or TaskuraiClient.RaiseTaskEvent.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<ExternalEvent>> WaitForExternalEventsAsync(string id, IList<string> eventNames, IList<string> completedSubTaskIds, long? maxDuration = -1, StepTrackingOptions options = null, Func<StepResponse, Progress, bool> progress = null, Func<StepResponse, Progress, Task<bool>> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<Taskurai.Models.ExternalEvent>>: System.Collections.Generic.List%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Collections.Generic.IList<System.String> | eventNames | List of event names. |
System.Collections.Generic.IList<System.String> | completedSubTaskIds | List of task ids. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Boolean> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task<System.Boolean>> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
CallTaskAsync<T>(string, Func<StepResponse, TaskConfig>, Func<StepResponse, Task<TaskConfig>>, long?, StepTrackingOptions, Action<StepResponse, Progress>, Func<StepResponse, Progress, Task>, StepStyle)
Durable create tasks and wait tasks to be completed (Succeeded or Failed, Canceled after optional retries).
To raise an event, use the method TaskuraiClient.RaiseTaskEventAsync or TaskuraiClient.RaiseTaskEvent.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<T> CallTaskAsync<T>(string id, Func<StepResponse, TaskConfig> init = null, Func<StepResponse, Task<TaskConfig>> initAsync = null, long? maxDuration = -1, StepTrackingOptions options = null, Action<StepResponse, Progress> progress = null, Func<StepResponse, Progress, Task> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<<T>>: Returns task output data (only single value supported).
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.TaskConfig> | init | Initialize task configuration delegate only called when step is initializing. |
System.Func<Taskurai.Models.StepResponse,System.Threading.Tasks.Task<Taskurai.Models.TaskConfig>> | initAsync | Initialize task configuration async delegate only called when step is initializing. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Action<Taskurai.Models.StepResponse,Taskurai.Models.Progress> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
Type Parameters
T
CallTaskAsync(string, Func<StepResponse, TaskConfig>, Func<StepResponse, Task<TaskConfig>>, long?, StepTrackingOptions, Action<StepResponse, Progress>, Func<StepResponse, Progress, Task>, StepStyle)
Durable create tasks and wait tasks to be completed (Succeeded or Failed, Canceled after optional retries).
To raise an event, use the method TaskuraiClient.RaiseTaskEventAsync or TaskuraiClient.RaiseTaskEvent.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<TaskResponse> CallTaskAsync(string id, Func<StepResponse, TaskConfig> init = null, Func<StepResponse, Task<TaskConfig>> initAsync = null, long? maxDuration = -1, StepTrackingOptions options = null, Action<StepResponse, Progress> progress = null, Func<StepResponse, Progress, Task> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<Taskurai.Models.TaskResponse>: Taskurai.Models.TaskResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.TaskConfig> | init | Initialize task configuration delegate only called when step is initializing. |
System.Func<Taskurai.Models.StepResponse,System.Threading.Tasks.Task<Taskurai.Models.TaskConfig>> | initAsync | Initialize task configuration async delegate only called when step is initializing. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Action<Taskurai.Models.StepResponse,Taskurai.Models.Progress> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
CallTasksAsync<T>(string, Action<StepResponse, IList<TaskConfig>>, Func<StepResponse, IList<TaskConfig>, Task>, long?, StepTrackingOptions, Action<StepResponse, Progress>, Func<StepResponse, Progress, Task>, StepStyle)
Durable create tasks and wait tasks to be completed (Succeeded or Failed, Canceled after optional retries).
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<T>> CallTasksAsync<T>(string id, Action<StepResponse, IList<TaskConfig>> init = null, Func<StepResponse, IList<TaskConfig>, Task> initAsync = null, long? maxDuration = -1, StepTrackingOptions options = null, Action<StepResponse, Progress> progress = null, Func<StepResponse, Progress, Task> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<<T>>>: Returns task output data (only single value supported), casted to specified type System.Collections.Generic.IEnumerable%601.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Action<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.TaskConfig>> | init | Initialize task configuration delegate only called when step is initializing. |
System.Func<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.TaskConfig>,System.Threading.Tasks.Task> | initAsync | Initialize task configuration async delegate only called when step is initializing. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Action<Taskurai.Models.StepResponse,Taskurai.Models.Progress> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
Type Parameters
T
CallTasksAsync(string, Action<StepResponse, IList<TaskConfig>>, Func<StepResponse, IList<TaskConfig>, Task>, long?, StepTrackingOptions, Action<StepResponse, Progress>, Func<StepResponse, Progress, Task>, StepStyle)
Durable create tasks and wait tasks to be completed (Succeeded or Failed, Canceled after optional retries).
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<TaskResponse>> CallTasksAsync(string id, Action<StepResponse, IList<TaskConfig>> init = null, Func<StepResponse, IList<TaskConfig>, Task> initAsync = null, long? maxDuration = -1, StepTrackingOptions options = null, Action<StepResponse, Progress> progress = null, Func<StepResponse, Progress, Task> progressAsync = null, StepStyle stepStyle = StepStyle.Suspend)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<Taskurai.Models.TaskResponse>>: System.Collections.Generic.List%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Action<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.TaskConfig>> | init | Initialize task configuration delegate only called when step is initializing. |
System.Func<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.TaskConfig>,System.Threading.Tasks.Task> | initAsync | Initialize task configuration async delegate only called when step is initializing. |
System.Nullable<System.Int64> | maxDuration | Maximum duration in seconds from start time to end time, -1 = unlimited. |
| Taskurai.Worker.StepTrackingOptions | options | Step tracking options Taskurai.Worker.StepTrackingOptions |
System.Action<Taskurai.Models.StepResponse,Taskurai.Models.Progress> | progress | Progress delegate System.Action%602, only called when stepStyle is StepStyle.Suspend. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.Progress,System.Threading.Tasks.Task> | progressAsync | Async progress delegate System.Func%603, only called when stepStyle is StepStyle.Suspend. |
| Taskurai.Models.StepStyle | stepStyle | Step style: suspend the command (default) or wait until completed Taskurai.Models.StepStyle. |
CreateTaskAsync(string, Func<StepResponse, TaskConfig>, Func<StepResponse, Task<TaskConfig>>)
Durable create tasks. This method does not wait for the task to be completed.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<TaskResponse> CreateTaskAsync(string id, Func<StepResponse, TaskConfig> init = null, Func<StepResponse, Task<TaskConfig>> initAsync = null)
Returns
System.Threading.Tasks.Task<Taskurai.Models.TaskResponse>: Taskurai.Models.TaskResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Func<Taskurai.Models.StepResponse,Taskurai.Models.TaskConfig> | init | Initialize task configuration delegate only called when step is initializing. |
System.Func<Taskurai.Models.StepResponse,System.Threading.Tasks.Task<Taskurai.Models.TaskConfig>> | initAsync | Initialize task configuration async delegate only called when step is initializing. |
CreateTasksAsync(string, Action<StepResponse, IList<TaskConfig>>, Func<StepResponse, IList<TaskConfig>, Task>)
Durable create tasks. This method does not wait for the task to be completed.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<List<TaskResponse>> CreateTasksAsync(string id, Action<StepResponse, IList<TaskConfig>> init = null, Func<StepResponse, IList<TaskConfig>, Task> initAsync = null)
Returns
System.Threading.Tasks.Task<System.Collections.Generic.List<Taskurai.Models.TaskResponse>>: System.Collections.Generic.List%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Action<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.TaskConfig>> | init | Initialize task configuration delegate only called when step is initializing. |
System.Func<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.TaskConfig>,System.Threading.Tasks.Task> | initAsync | Initialize task configuration async delegate only called when step is initializing. |
RunInlineAsync<T>(string, Action<StepResponse, IList<StepArgument>>, Func<StepResponse, IList<StepArgument>, Task>, Delegate, double?, StepExecutionOptions)
Durable run code inline.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<T> RunInlineAsync<T>(string id, Action<StepResponse, IList<StepArgument>> init = null, Func<StepResponse, IList<StepArgument>, Task> initAsync = null, Delegate run = null, double? runTimeout = null, StepExecutionOptions executionOptions = null)
Returns
System.Threading.Tasks.Task<<T>>: Returns step output data (only single value supported).
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Action<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.StepArgument>> | init | Initialize step configuration delegate only called when step is initializing. |
| Ensures the step is initialized only once with deterministic values such as GUIDs, timestamps, and | ||
| other state-defining data. This guarantees idempotency and prevents variability during retries, | ||
| ensuring consistent and predictable behavior. | ||
System.Func<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.StepArgument>,System.Threading.Tasks.Task> | initAsync | Initialize step configuration async delegate only called when step is initializing. |
| Ensures the step is initialized only once with deterministic values such as GUIDs, timestamps, and | ||
| other state-defining data. This guarantees idempotency and prevents variability during retries, | ||
| ensuring consistent and predictable behavior. | ||
System.Delegate | run | Run code inline. Initialize non-deterministic values in the initialization delegate. |
| This code can rerun on task or step failure (depending on the execution options of the task and the step). | ||
| Supports both sync and async delegates. | ||
System.Nullable<System.Double> | runTimeout | Run timeout in seconds for the current run (Total maximum duration of the step can be set in executionOptions -> MaxDuration). |
| Taskurai.Models.StepExecutionOptions | executionOptions | Step execution options: max duration and retry options Taskurai.Models.StepExecutionOptions. |
Type Parameters
T
RunInlineAsync(string, Action<StepResponse, IList<StepArgument>>, Func<StepResponse, IList<StepArgument>, Task>, Delegate, double?, StepExecutionOptions)
Durable run code inline.
Each step needs an unique step id. When a task is retried, the step is evaluated, when the step was already successfully executed, the result is returned.
Required scope: Data/Buildby.Taskurai/steps/create
Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.
Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.
public Task<StepResponse> RunInlineAsync(string id, Action<StepResponse, IList<StepArgument>> init = null, Func<StepResponse, IList<StepArgument>, Task> initAsync = null, Delegate run = null, double? runTimeout = null, StepExecutionOptions executionOptions = null)
Returns
System.Threading.Tasks.Task<Taskurai.Models.StepResponse>: Taskurai.Models.StepResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.String | id | A unique step id. |
System.Action<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.StepArgument>> | init | Initialize step configuration delegate only called when step is initializing. |
| Ensures the step is initialized only once with deterministic values such as GUIDs, timestamps, and | ||
| other state-defining data. This guarantees idempotency and prevents variability during retries, | ||
| ensuring consistent and predictable behavior. | ||
System.Func<Taskurai.Models.StepResponse,System.Collections.Generic.IList<Taskurai.Models.StepArgument>,System.Threading.Tasks.Task> | initAsync | Initialize step configuration async delegate only called when step is initializing. |
| Ensures the step is initialized only once with deterministic values such as GUIDs, timestamps, and | ||
| other state-defining data. This guarantees idempotency and prevents variability during retries, | ||
| ensuring consistent and predictable behavior. | ||
System.Delegate | run | Run code inline. Initialize non-deterministic values in the initialization delegate. |
| This code can rerun on task or step failure (depending on the execution options of the task and the step). | ||
| Supports both sync and async delegates. | ||
System.Nullable<System.Double> | runTimeout | Run timeout in seconds for the current run (Total maximum duration of the step can be set in executionOptions -> MaxDuration). |
| Taskurai.Models.StepExecutionOptions | executionOptions | Step execution options: max duration and retry options Taskurai.Models.StepExecutionOptions. |
Implements
System.IDisposable