Class TaskuraiClient

A TaskuraiClient provides access to the Taskurai api.

Assembly: Taskurai.dll

Declaration

public class TaskuraiClient : TaskuraiBaseClient

Inheritance: System.Object -> Taskurai.TaskuraiBaseClient

Methods

GetLogsClient()

Create a new logs client that uses the same request policy pipeline as the Taskurai.TaskuraiClient.

Declaration

public virtual TaskuraiLogsClient GetLogsClient()

Returns

Taskurai.TaskuraiLogsClient

GetStateClient()

Create a new Taskurai.TaskuraiStateClient object. The new Taskurai.TaskuraiStateClient uses the same request policy pipeline and isolation mode as the Taskurai.TaskuraiClient.

Declaration

public virtual TaskuraiStateClient GetStateClient()

Returns

Taskurai.TaskuraiStateClient

GetStepsClient()

Create a new Taskurai.TaskuraiStepsClient object. The new Taskurai.TaskuraiStepsClient uses the same request policy pipeline and isolation mode as the Taskurai.TaskuraiClient.

Declaration

public virtual TaskuraiStepsClient GetStepsClient()

Returns

Taskurai.TaskuraiStepsClient

GetLocksClient()

Create a new Taskurai.TaskuraiLocksClient object. The new Taskurai.TaskuraiLocksClient uses the same request policy pipeline and isolation mode as the Taskurai.TaskuraiClient.

Declaration

public virtual TaskuraiLocksClient GetLocksClient()

Returns

Taskurai.TaskuraiLocksClient

CreateTask(TaskConfig, CancellationToken)

Creates a task.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual TaskResponse CreateTask(TaskConfig input, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.TaskResponse: Taskurai.Models.TaskResponse

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

CreateTaskAsync(TaskConfig, CancellationToken)

Creates a task.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual Task<TaskResponse> CreateTaskAsync(TaskConfig input, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

CreateTaskAndWaitForResult(TaskConfig, CancellationToken)

Creates a task and wait for a task to be completed.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual TaskResponse CreateTaskAndWaitForResult(TaskConfig input, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.TaskResponse: Taskurai.Models.TaskResponse

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

CreateTaskAndWaitForResultAsync(TaskConfig, CancellationToken)

Creates a task and returns operation to wait for a task to be completed.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual Task<TaskResponse> CreateTaskAndWaitForResultAsync(TaskConfig input, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

CreateTaskAndWaitForResult<T>(TaskConfig, CancellationToken)

Creates a task and wait for a task to be completed.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual T CreateTaskAndWaitForResult<T>(TaskConfig input, CancellationToken cancellationToken = default)

Returns

<T>: Returns task output data (only single value supported).

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

CreateTaskAndWaitForResultAsync<T>(TaskConfig, CancellationToken)

Creates a task and returns operation to wait for a task to be completed.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual Task<T> CreateTaskAndWaitForResultAsync<T>(TaskConfig input, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<<T>>: Returns task output data (only single value supported).

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

CreateTaskAndWait(TaskConfig, CancellationToken)

Creates a task and returns operation to wait for a task to be completed.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual CreateTaskAndWaitOperation CreateTaskAndWait(TaskConfig input, CancellationToken cancellationToken = default)

Returns

Taskurai.CreateTaskAndWaitOperation: Taskurai.CreateTaskAndWaitOperation

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

CreateTaskAndWaitAsync(TaskConfig, CancellationToken)

Creates a task and returns operation to wait for a task to be completed.

Required scope: Data/Buildby.Taskurai/tasks/create

Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read. Optional scope to return read global secrets: Data/Buildby.Taskurai/secrets/read.

Declaration

public virtual Task<CreateTaskAndWaitOperation> CreateTaskAndWaitAsync(TaskConfig input, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.CreateTaskAndWaitOperation>: Taskurai.CreateTaskAndWaitOperation

Parameters

Type	Name	Description
Taskurai.Models.TaskConfig	input	Taskurai.Models.TaskConfig.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTasks(TaskListOptions, CancellationToken)

Enumerate tasks.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual Pageable<TaskResponse> ListTasks(TaskListOptions options = null, CancellationToken cancellationToken = default)

Returns

Azure.Pageable<Taskurai.Models.TaskResponse>: Azure.Pageable%601

Parameters

Type	Name	Description
Taskurai.Models.TaskListOptions	options	Taskurai.Models.TaskListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTasksAsync(TaskListOptions, CancellationToken)

Enumerate tasks.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual AsyncPageable<TaskResponse> ListTasksAsync(TaskListOptions options = null, CancellationToken cancellationToken = default)

Returns

Azure.AsyncPageable<Taskurai.Models.TaskResponse>: Azure.AsyncPageable%601

Parameters

Type	Name	Description
Taskurai.Models.TaskListOptions	options	Taskurai.Models.TaskListOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetTask(string, CancellationToken)

Get task by ID.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual TaskResponse GetTask(string id, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.TaskResponse: Taskurai.Models.TaskResponse

Parameters

Type	Name	Description
System.String	id	Task ID
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetTaskAsync(string, CancellationToken)

Get task by ID.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual Task<TaskResponse> GetTaskAsync(string id, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	id	Task ID
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UpdateTask(string, TaskUpdateInput, CancellationToken)

Updates a task.

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

Declaration

public virtual TaskResponse UpdateTask(string id, TaskUpdateInput input, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.TaskResponse: Taskurai.Models.TaskResponse

Parameters

Type	Name	Description
System.String	id	Task ID
Taskurai.Models.TaskUpdateInput	input	Taskurai.Models.TaskUpdateInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UpdateTaskAsync(string, TaskUpdateInput, CancellationToken)

Updates a task.

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

Declaration

public virtual Task<TaskResponse> UpdateTaskAsync(string id, TaskUpdateInput input, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	id	Task ID
Taskurai.Models.TaskUpdateInput	input	Taskurai.Models.TaskUpdateInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteTask(string, CancellationToken)

Deletes a task.

Required scope: Data/Buildby.Taskurai/tasks/delete

Declaration

public virtual void DeleteTask(string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.String	id	Task ID
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteTaskAsync(string, CancellationToken)

Deletes a task.

Required scope: Data/Buildby.Taskurai/tasks/delete

Declaration

public virtual Task DeleteTaskAsync(string id, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name	Description
System.String	id	Task ID
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

RaiseTaskEvent(string, string, ValueData<object>, CancellationToken)

Raise a task event.

Required scope: Data/Buildby.Taskurai/events/create

Declaration

public virtual void RaiseTaskEvent(string id, string eventName, ValueData<object> eventData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.String	id	Task id.
System.String	eventName	Event name.
Taskurai.Models.ValueData<T>	eventData	Event name.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

RaiseTaskEventAsync(string, string, ValueData<object>, CancellationToken)

Raise a task event.

Required scope: Data/Buildby.Taskurai/events/create

Declaration

public virtual Task RaiseTaskEventAsync(string id, string eventName, ValueData<object> eventData, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name	Description
System.String	id	Task id.
System.String	eventName	Event name.
Taskurai.Models.ValueData<T>	eventData	Event name.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskExternalEvents(string, CancellationToken)

Enumerate external events for a task.

Required scope: Data/Buildby.Taskurai/events/read

Declaration

public virtual Pageable<ExternalEvent> ListTaskExternalEvents(string taskId, CancellationToken cancellationToken = default)

Returns

Azure.Pageable<Taskurai.Models.ExternalEvent>: Azure.Pageable%601

Parameters

Type	Name	Description
System.String	taskId	Task id.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskExternalEventsAsync(string, CancellationToken)

Enumerate external events for a task.

Required scope: Data/Buildby.Taskurai/events/read

Declaration

public virtual AsyncPageable<ExternalEvent> ListTaskExternalEventsAsync(string taskId, CancellationToken cancellationToken = default)

Returns

Azure.AsyncPageable<Taskurai.Models.ExternalEvent>: Azure.AsyncPageable%601

Parameters

Type	Name	Description
System.String	taskId	Task id.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistory(string, TaskListHistoryOptions, CancellationToken)

List task history, includes all previous runs and the current task.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual Pageable<TaskHistoryResponse> ListTaskHistory(string id, TaskListHistoryOptions options = null, CancellationToken cancellationToken = default)

Returns

Azure.Pageable<Taskurai.Models.TaskHistoryResponse>: Azure.Pageable%601

Parameters

Type	Name	Description
System.String	id	Task ID
Taskurai.Models.TaskListHistoryOptions	options	Taskurai.Models.TaskListHistoryOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListTaskHistoryAsync(string, TaskListHistoryOptions, CancellationToken)

List task history, includes all previous runs and the current task.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual AsyncPageable<TaskHistoryResponse> ListTaskHistoryAsync(string id, TaskListHistoryOptions options = null, CancellationToken cancellationToken = default)

Returns

Azure.AsyncPageable<Taskurai.Models.TaskHistoryResponse>: Azure.AsyncPageable%601

Parameters

Type	Name	Description
System.String	id	Task ID
Taskurai.Models.TaskListHistoryOptions	options	Taskurai.Models.TaskListHistoryOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetTaskHistory(string, long, CancellationToken)

Get a task history by run count, can also retrieve the current task.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual TaskHistoryResponse GetTaskHistory(string id, long runCount, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.TaskHistoryResponse: Taskurai.Models.TaskHistoryResponse

Parameters

Type	Name	Description
System.String	id	Task ID
System.Int64	runCount	Task run count
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetTaskHistoryAsync(string, long, CancellationToken)

Get a task history by run count, can also retrieve the current task.

Required scope: Data/Buildby.Taskurai/tasks/read

Declaration

public virtual Task<TaskHistoryResponse> GetTaskHistoryAsync(string id, long runCount, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	id	Task ID
System.Int64	runCount	Task run count
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.