Class TaskuraiStateClient

A TaskuraiStateClient provides access to the Taskurai State api.

Assembly: Taskurai.dll

Declaration

public class TaskuraiStateClient : TaskuraiBaseClient

Inheritance: System.Object -> Taskurai.TaskuraiBaseClient

Methods

SaveState(string, StateInput, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse SaveState(string storeName, StateInput input, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveStateAsync(string, StateInput, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> SaveStateAsync(string storeName, StateInput input, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, StateInput, string, bool, CancellationToken)

Saves a new blob state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse SaveBlobState(string storeName, StateInput input, string filePath, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	filePath	File path containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, StateInput, string, bool, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> SaveBlobStateAsync(string storeName, StateInput input, string filePath, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	filePath	File path containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, StateInput, string, BlobUploadOptions, CancellationToken)

Saves a new blob state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse SaveBlobState(string storeName, StateInput input, string filePath, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	filePath	File path containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, StateInput, string, BlobUploadOptions, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> SaveBlobStateAsync(string storeName, StateInput input, string filePath, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	filePath	File path containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, StateInput, Stream, bool, CancellationToken)

Saves a new blob state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse SaveBlobState(string storeName, StateInput input, Stream content, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, StateInput, Stream, bool, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> SaveBlobStateAsync(string storeName, StateInput input, Stream content, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, StateInput, Stream, BlobUploadOptions, CancellationToken)

Saves a new blob state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse SaveBlobState(string storeName, StateInput input, Stream content, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, StateInput, Stream, BlobUploadOptions, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> SaveBlobStateAsync(string storeName, StateInput input, Stream content, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, StateInput, BinaryData, bool, CancellationToken)

Saves a new blob state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse SaveBlobState(string storeName, StateInput input, BinaryData data, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, StateInput, BinaryData, bool, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> SaveBlobStateAsync(string storeName, StateInput input, BinaryData data, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, StateInput, BinaryData, BlobUploadOptions, CancellationToken)

Saves a new blob state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse SaveBlobState(string storeName, StateInput input, BinaryData data, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.BinaryData	data	A System.BinaryData containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, StateInput, BinaryData, BlobUploadOptions, CancellationToken)

Saves a new state entry.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> SaveBlobStateAsync(string storeName, StateInput input, BinaryData data, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.BinaryData	data	A System.BinaryData containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, string, bool, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, string filePath, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.String	filePath	File path containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, string, bool, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, string filePath, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.String	filePath	File path containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, string, BlobUploadOptions, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, string filePath, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.String	filePath	File path containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, string, BlobUploadOptions, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, string filePath, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.String	filePath	File path containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, Stream, bool, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, Stream content, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, Stream, bool, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, Stream content, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, Stream, BlobUploadOptions, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, Stream content, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, Stream, BlobUploadOptions, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, Stream content, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, BinaryData, bool, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, BinaryData content, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.BinaryData	content	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, BinaryData, bool, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, BinaryData content, bool overwrite = false, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.BinaryData	content	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, BinaryData, BlobUploadOptions, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, BinaryData content, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.BinaryData	content	A System.BinaryData containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, BinaryData, BlobUploadOptions, CancellationToken)

Upload blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, BinaryData content, BlobUploadOptions options, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.BinaryData	content	A System.BinaryData containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBulkState(string, StateBulkInput, CancellationToken)

Save a array of state in the state store using id and options.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual IEnumerable<StateResponse> SaveBulkState(string storeName, StateBulkInput input, CancellationToken cancellationToken = default)

Returns

System.Collections.Generic.IEnumerable<Taskurai.Models.StateResponse>: System.Collections.Generic.IEnumerable%601

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateBulkInput	input	Taskurai.Models.StateBulkInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBulkStateAsync(string, StateBulkInput, CancellationToken)

Save a array of state in the state store using id and options.

Required scope: Data/Buildby.Taskurai/state/create. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<IEnumerable<StateResponse>> SaveBulkStateAsync(string storeName, StateBulkInput input, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Taskurai.Models.StateResponse>>: System.Collections.Generic.IEnumerable%601

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateBulkInput	input	Taskurai.Models.StateBulkInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

BulkTransaction(string, StateBulkTransactionInput, CancellationToken)

Bulk upsert and delete state operations in the state store using id and options using a transaction.

Required scope: Data/Buildby.Taskurai/state/create, Data/Buildby.Taskurai/state/delete. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual IEnumerable<StateResponse> BulkTransaction(string storeName, StateBulkTransactionInput input, CancellationToken cancellationToken = default)

Returns

System.Collections.Generic.IEnumerable<Taskurai.Models.StateResponse>: List of upserted state entries: System.Collections.Generic.IEnumerable%601

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateBulkTransactionInput	input	Taskurai.Models.StateBulkTransactionInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

BulkTransactionAsync(string, StateBulkTransactionInput, CancellationToken)

Bulk upsert and delete state operations in the state store using id and options using a transaction.

Required scope: Data/Buildby.Taskurai/state/create, Data/Buildby.Taskurai/state/delete. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<IEnumerable<StateResponse>> BulkTransactionAsync(string storeName, StateBulkTransactionInput input, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Taskurai.Models.StateResponse>>: List of upserted state entries: System.Collections.Generic.IEnumerable%601

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateBulkTransactionInput	input	Taskurai.Models.StateBulkTransactionInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListState<T>(string, StateListInput, JsonSerializerOptions, CancellationToken)

Enumerate state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Pageable<T> ListState<T>(string storeName, StateListInput input = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

Azure.Pageable<<T>>: List of state data.

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStateAsync<T>(string, StateListInput, JsonSerializerOptions, CancellationToken)

Enumerate state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual AsyncPageable<T> ListStateAsync<T>(string storeName, StateListInput input = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

Azure.AsyncPageable<<T>>: List of state data.

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListState(string, StateListInput, CancellationToken)

Enumerate state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Pageable<StateResponse> ListState(string storeName, StateListInput input = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStateAsync(string, StateListInput, CancellationToken)

Enumerate state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual AsyncPageable<StateResponse> ListStateAsync(string storeName, StateListInput input = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetState<T>(string, string, StateGetOptions, JsonSerializerOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual T GetState<T>(string storeName, string id, StateGetOptions options = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

<T>: State data.

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetStateAsync<T>(string, string, StateGetOptions, JsonSerializerOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<T> GetStateAsync<T>(string storeName, string id, StateGetOptions options = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<<T>>: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetState<T>(StateReference, StateGetOptions, JsonSerializerOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual T GetState<T>(StateReference stateReference, StateGetOptions options = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

<T>: State data.

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetStateAsync<T>(StateReference, StateGetOptions, JsonSerializerOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<T> GetStateAsync<T>(StateReference stateReference, StateGetOptions options = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<<T>>: State data.

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetState(string, string, StateGetOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse GetState(string storeName, string id, StateGetOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetStateAsync(string, string, StateGetOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> GetStateAsync(string storeName, string id, StateGetOptions options = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetState(StateReference, StateGetOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse GetState(StateReference stateReference, StateGetOptions options = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetStateAsync(StateReference, StateGetOptions, CancellationToken)

Get a state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> GetStateAsync(StateReference stateReference, StateGetOptions options = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateTo(string, string, string, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse GetBlobStateTo(string storeName, string id, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
System.String	filePath	File path to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateToAsync(string, string, string, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> GetBlobStateToAsync(string storeName, string id, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
System.String	filePath	File path to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateTo(StateReference, string, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse GetBlobStateTo(StateReference stateReference, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
System.String	filePath	File path to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateToAsync(StateReference, string, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> GetBlobStateToAsync(StateReference stateReference, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
System.String	filePath	File path to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateTo(string, string, Stream, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse GetBlobStateTo(string storeName, string id, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
System.IO.Stream	destination	Stream to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateToAsync(string, string, Stream, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> GetBlobStateToAsync(string storeName, string id, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
System.IO.Stream	destination	Stream to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateTo(StateReference, Stream, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateResponse GetBlobStateTo(StateReference stateReference, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
System.IO.Stream	destination	Stream to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateToAsync(StateReference, Stream, StateGetOptions, BlobDownloadToOptions, CancellationToken)

Download blob and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateResponse> GetBlobStateToAsync(StateReference stateReference, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
System.IO.Stream	destination	Stream to write download content to.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContent(string, string, StateGetOptions, BlobDownloadOptions, CancellationToken)

Download content of a blob for a state and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateDownloadResponse GetBlobStateContent(string storeName, string id, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateDownloadResponse: Taskurai.Models.StateDownloadResponse

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContentAsync(string, string, StateGetOptions, BlobDownloadOptions, CancellationToken)

Download content of a blob for a state and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateDownloadResponse> GetBlobStateContentAsync(string storeName, string id, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContent(StateReference, StateGetOptions, BlobDownloadOptions, CancellationToken)

Download content of a blob for a state and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual StateDownloadResponse GetBlobStateContent(StateReference stateReference, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.StateDownloadResponse: Taskurai.Models.StateDownloadResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContentAsync(StateReference, StateGetOptions, BlobDownloadOptions, CancellationToken)

Download content of a blob for a state and get a blob state entry.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<StateDownloadResponse> GetBlobStateContentAsync(StateReference stateReference, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobTo(StateResponse, string, BlobDownloadToOptions, CancellationToken)

Download a blob for a state (created with hasBlob = true).

Declaration

public virtual Response DownloadBlobTo(StateResponse stateResponse, string filePath, BlobDownloadToOptions options = null, CancellationToken cancellationToken = default)

Returns

Azure.Response: Azure.Response

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.String	filePath	File path to write download content to.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	options	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobToAsync(StateResponse, string, BlobDownloadToOptions, CancellationToken)

Download a blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response> DownloadBlobToAsync(StateResponse stateResponse, string filePath, BlobDownloadToOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response>: Azure.Response

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.String	filePath	File path to write download content to.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	options	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobTo(StateResponse, Stream, BlobDownloadToOptions, CancellationToken)

Download a blob for a state (created with hasBlob = true).

Declaration

public virtual Response DownloadBlobTo(StateResponse stateResponse, Stream destination, BlobDownloadToOptions options = null, CancellationToken cancellationToken = default)

Returns

Azure.Response: Azure.Response

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.IO.Stream	destination	Stream to write download content to.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	options	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobToAsync(StateResponse, Stream, BlobDownloadToOptions, CancellationToken)

Download a blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response> DownloadBlobToAsync(StateResponse stateResponse, Stream destination, BlobDownloadToOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response>: Azure.Response

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
System.IO.Stream	destination	Stream to write download content to.
Azure.Storage.Blobs.Models.BlobDownloadToOptions	options	Azure.Storage.Blobs.Models.BlobDownloadToOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobContent(StateResponse, BlobDownloadOptions, CancellationToken)

Download content of a blob for a state (created with hasBlob = true).

Declaration

public virtual Response<BlobDownloadResult> DownloadBlobContent(StateResponse stateResponse, BlobDownloadOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobContentAsync(StateResponse, BlobDownloadOptions, CancellationToken)

Download content of a blob for a state (created with hasBlob = true).

Declaration

public virtual Task<Response<BlobDownloadResult>> DownloadBlobContentAsync(StateResponse stateResponse, BlobDownloadOptions downloadOptions = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>>: Azure.Response%601

Parameters

Type	Name	Description
Taskurai.Models.StateResponse	stateResponse	Taskurai.Models.StateResponse
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkState<T>(string, StateGetBulkInput, JsonSerializerOptions, CancellationToken)

Get bulk state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual IEnumerable<T> GetBulkState<T>(string storeName, StateGetBulkInput input = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

System.Collections.Generic.IEnumerable<<T>>: List of state data.

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkStateAsync<T>(string, StateGetBulkInput, JsonSerializerOptions, CancellationToken)

Get bulk state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<IEnumerable<T>> GetBulkStateAsync<T>(string storeName, StateGetBulkInput input = null, JsonSerializerOptions serializerOptions = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<<T>>>: List of state data.

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkState(string, StateGetBulkInput, CancellationToken)

Get bulk state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual IEnumerable<StateResponse> GetBulkState(string storeName, StateGetBulkInput input = null, CancellationToken cancellationToken = default)

Returns

System.Collections.Generic.IEnumerable<Taskurai.Models.StateResponse>: System.Collections.Generic.IEnumerable%601

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkStateAsync(string, StateGetBulkInput, CancellationToken)

Get bulk state.

Required scope: Data/Buildby.Taskurai/state/read. Optional scope to return sensitive data: Data/Buildby.Taskurai/sensitive/read.

Declaration

public virtual Task<IEnumerable<StateResponse>> GetBulkStateAsync(string storeName, StateGetBulkInput input = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Taskurai.Models.StateResponse>>: System.Collections.Generic.IEnumerable%601

Parameters

Type	Name	Description
System.String	storeName	State store name.
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteState(string, string, StateDeleteOptions, CancellationToken)

Delete a state entry.

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

Declaration

public virtual void DeleteState(string storeName, string id, StateDeleteOptions options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID
Taskurai.Models.StateDeleteOptions	options	Taskurai.Models.StateDeleteOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteStateAsync(string, string, StateDeleteOptions, CancellationToken)

Delete a state entry.

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

Declaration

public virtual Task DeleteStateAsync(string storeName, string id, StateDeleteOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name	Description
System.String	storeName	State store name.
System.String	id	State ID
Taskurai.Models.StateDeleteOptions	options	Taskurai.Models.StateDeleteOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteState(StateReference, StateDeleteOptions, CancellationToken)

Delete a state entry.

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

Declaration

public virtual void DeleteState(StateReference stateReference, StateDeleteOptions options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateDeleteOptions	options	Taskurai.Models.StateDeleteOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteStateAsync(StateReference, StateDeleteOptions, CancellationToken)

Delete a state entry.

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

Declaration

public virtual Task DeleteStateAsync(StateReference stateReference, StateDeleteOptions options = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateDeleteOptions	options	Taskurai.Models.StateDeleteOptions.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.