Class TaskuraiStepsClient
A TaskuraiStepsClient provides access to the Taskurai steps api.
Assembly: Taskurai.dll
public class TaskuraiStepsClient : TaskuraiBaseClient
Inheritance: System.Object -> Taskurai.TaskuraiBaseClient
Methods
ListSteps(string, StepListOptions, CancellationToken)
Enumerate steps.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual Pageable<StepResponse> ListSteps(string taskId, StepListOptions options = null, CancellationToken cancellationToken = default)
Returns
Azure.Pageable<Taskurai.Models.StepResponse>: Azure.Pageable%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task id. |
| Taskurai.Models.StepListOptions | options | Taskurai.Models.StepListOptions. |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
ListTasksAsync(string, StepListOptions, CancellationToken)
Enumerate steps.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual AsyncPageable<StepResponse> ListTasksAsync(string taskId, StepListOptions options = null, CancellationToken cancellationToken = default)
Returns
Azure.AsyncPageable<Taskurai.Models.StepResponse>: Azure.AsyncPageable%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task id. |
| Taskurai.Models.StepListOptions | options | Taskurai.Models.StepListOptions. |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
GetStep(string, string, CancellationToken)
Get step by ID.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual StepResponse GetStep(string taskId, string stepId, CancellationToken cancellationToken = default)
Returns
Taskurai.Models.StepResponse: Taskurai.Models.StepResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
GetStepAsync(string, string, CancellationToken)
Get step by ID.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual Task<StepResponse> GetStepAsync(string taskId, string stepId, CancellationToken cancellationToken = default)
Returns
System.Threading.Tasks.Task<Taskurai.Models.StepResponse>: Taskurai.Models.StepResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
DeleteStep(string, string, CancellationToken)
Deletes a step.
Required scope: Data/Buildby.Taskurai/steps/delete
public virtual void DeleteStep(string taskId, string stepId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
DeleteStepAsync(string, string, CancellationToken)
Deletes a step.
Required scope: Data/Buildby.Taskurai/steps/delete
public virtual Task DeleteStepAsync(string taskId, string stepId, CancellationToken cancellationToken = default)
Returns
System.Threading.Tasks.Task
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
ListStepHistory(string, string, StepListHistoryOptions, CancellationToken)
List step history, includes all previous runs and the current step.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual Pageable<StepHistoryResponse> ListStepHistory(string taskId, string stepId, StepListHistoryOptions options = null, CancellationToken cancellationToken = default)
Returns
Azure.Pageable<Taskurai.Models.StepHistoryResponse>: Azure.Pageable%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
| Taskurai.Models.StepListHistoryOptions | options | Taskurai.Models.StepListHistoryOptions. |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
ListStepHistoryAsync(string, string, StepListHistoryOptions, CancellationToken)
List step history, includes all previous runs and the current step.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual AsyncPageable<StepHistoryResponse> ListStepHistoryAsync(string taskId, string stepId, StepListHistoryOptions options = null, CancellationToken cancellationToken = default)
Returns
Azure.AsyncPageable<Taskurai.Models.StepHistoryResponse>: Azure.AsyncPageable%601
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
| Taskurai.Models.StepListHistoryOptions | options | Taskurai.Models.StepListHistoryOptions. |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
GetStepHistory(string, string, long, CancellationToken)
Get a step history by run count, can also retrieve the current step.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual StepHistoryResponse GetStepHistory(string taskId, string stepId, long runCount, CancellationToken cancellationToken = default)
Returns
Taskurai.Models.StepHistoryResponse: Taskurai.Models.StepHistoryResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
System.Int64 | runCount | Task run count |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.
GetStepHistoryAsync(string, string, long, CancellationToken)
Get a step history by run count, can also retrieve the current step.
Required scope: Data/Buildby.Taskurai/steps/read
public virtual Task<StepHistoryResponse> GetStepHistoryAsync(string taskId, string stepId, long runCount, CancellationToken cancellationToken = default)
Returns
System.Threading.Tasks.Task<Taskurai.Models.StepHistoryResponse>: Taskurai.Models.StepHistoryResponse
Parameters
| Type | Name | Description |
|---|---|---|
System.String | taskId | Task ID |
System.String | stepId | Step ID |
System.Int64 | runCount | Task run count |
System.Threading.CancellationToken | cancellationToken | System.Threading.CancellationToken |
Exceptions
Azure.RequestFailedException
Throws if request fails.