Class TaskuraiStateContext

State context

Assembly: Taskurai.Worker.dll

Declaration

public class TaskuraiStateContext : IDisposable

Implements:
System.IDisposable

Properties

StateClient

Taskurai state client Taskurai.TaskuraiClient.

Declaration

public TaskuraiStateClient StateClient { get; }

Methods

Dispose()

Dispose

Declaration

public void Dispose()

ComposeTaskStateId(string, string)

Compose task state id

Declaration

public static string ComposeTaskStateId(string taskId, string stateId)

Returns

System.String: Task state id.

Parameters

Type	Name	Description
System.String	taskId	Task id.
System.String	stateId	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).

SaveState<T>(string, T, bool?, int?, string)

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 StateResponse SaveState<T>(string id, T data, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
<T>	data	Data of type T.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveStateAsync<T>(string, T, bool?, int?, string)

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 Task<StateResponse> SaveStateAsync<T>(string id, T data, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
<T>	data	Data of type T.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveState<T>(StateReference, T, bool?, int?)

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 StateResponse SaveState<T>(StateReference stateReference, T data, bool? sensitive = null, int? ttlSeconds = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
<T>	data	Data of type T.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveStateAsync<T>(StateReference, T, bool?, int?)

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 Task<StateResponse> SaveStateAsync<T>(StateReference stateReference, T data, bool? sensitive = null, int? ttlSeconds = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
<T>	data	Data of type T.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveState(StateInput, string)

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 StateResponse SaveState(StateInput input, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveStateAsync(StateInput, string)

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 Task<StateResponse> SaveStateAsync(StateInput input, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, string, bool, bool?, int?, string)

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 StateResponse SaveBlobState(string id, string filePath, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.String	filePath	File path containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, string, bool, bool?, int?, string)

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 Task<StateResponse> SaveBlobStateAsync(string id, string filePath, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.String	filePath	File path containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateReference, string, bool, bool?, int?)

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 StateResponse SaveBlobState(StateReference stateReference, string filePath, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null)

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 containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateReference, string, bool, bool?, int?)

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 Task<StateResponse> SaveBlobStateAsync(StateReference stateReference, string filePath, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null)

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 containing the content to upload
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateInput, string, bool, string)

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 StateResponse SaveBlobState(StateInput input, string filePath, bool overwrite = false, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	filePath	File path containing the content to upload.
System.Boolean	overwrite	Should existing blobs be overwritten. Default is false.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateInput, string, bool, string)

Saves a new blob state entry asynchronously.

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

Declaration

public Task<StateResponse> SaveBlobStateAsync(StateInput input, string filePath, bool overwrite = false, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.String	filePath	File path containing the content to upload.
System.Boolean	overwrite	Should existing blobs be overwritten. Default is false.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, string, BlobUploadOptions, bool?, int?, string)

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 StateResponse SaveBlobState(string id, string filePath, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.String	filePath	File path containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, string, BlobUploadOptions, bool?, int?, string)

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 Task<StateResponse> SaveBlobStateAsync(string id, string filePath, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.String	filePath	File path containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateReference, string, BlobUploadOptions, bool?, int?)

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 StateResponse SaveBlobState(StateReference stateReference, string filePath, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null)

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 containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateReference, string, BlobUploadOptions, bool?, int?)

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 Task<StateResponse> SaveBlobStateAsync(StateReference stateReference, string filePath, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null)

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 containing the content to upload
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateInput, string, BlobUploadOptions, string)

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 StateResponse SaveBlobState(StateInput input, string filePath, BlobUploadOptions options, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateInput, string, BlobUploadOptions, string)

Saves a new blob state entry asynchronously.

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

Declaration

public Task<StateResponse> SaveBlobStateAsync(StateInput input, string filePath, BlobUploadOptions options, string storeName = null)

Returns

System.Threading.Tasks.Task<Taskurai.Models.StateResponse>: A task that represents the asynchronous operation. The task result contains a Taskurai.Models.StateResponse.

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, Stream, bool, bool?, int?, string)

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 StateResponse SaveBlobState(string id, Stream content, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, Stream, bool, bool?, int?, string)

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 Task<StateResponse> SaveBlobStateAsync(string id, Stream content, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateReference, Stream, bool, bool?, int?)

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 StateResponse SaveBlobState(StateReference stateReference, Stream content, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateReference, Stream, bool, bool?, int?)

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 Task<StateResponse> SaveBlobStateAsync(StateReference stateReference, Stream content, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null)

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	content	A System.IO.Stream containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateInput, Stream, bool, string)

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 StateResponse SaveBlobState(StateInput input, Stream content, bool overwrite = false, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
System.Boolean	overwrite	Should existing blobs be overwritten. Default is false.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateInput, Stream, bool, string)

Saves a new blob state entry asynchronously.

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

Declaration

public Task<StateResponse> SaveBlobStateAsync(StateInput input, Stream content, bool overwrite = false, string storeName = null)

Returns

System.Threading.Tasks.Task<Taskurai.Models.StateResponse>: A task that represents the asynchronous operation. The task result contains a Taskurai.Models.StateResponse.

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.IO.Stream	content	A System.IO.Stream containing the content to upload.
System.Boolean	overwrite	Should existing blobs be overwritten. Default is false.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, Stream, BlobUploadOptions, bool?, int?, string)

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 StateResponse SaveBlobState(string id, Stream content, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, Stream, BlobUploadOptions, bool?, int?, string)

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 Task<StateResponse> SaveBlobStateAsync(string id, Stream content, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateReference, Stream, BlobUploadOptions, bool?, int?)

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 StateResponse SaveBlobState(StateReference stateReference, Stream content, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateReference, Stream, BlobUploadOptions, bool?, int?)

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 Task<StateResponse> SaveBlobStateAsync(StateReference stateReference, Stream content, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null)

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	content	A System.IO.Stream containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateInput, Stream, BlobUploadOptions, string)

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 StateResponse SaveBlobState(StateInput input, Stream content, BlobUploadOptions options, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateInput, Stream, BlobUploadOptions, string)

Saves a new blob state entry asynchronously.

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

Declaration

public Task<StateResponse> SaveBlobStateAsync(StateInput input, Stream content, BlobUploadOptions options, string storeName = null)

Returns

System.Threading.Tasks.Task<Taskurai.Models.StateResponse>: A task that represents the asynchronous operation. The task result contains a Taskurai.Models.StateResponse.

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, BinaryData, bool, bool?, int?, string)

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 StateResponse SaveBlobState(string id, BinaryData data, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, BinaryData, bool, bool?, int?, string)

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 Task<StateResponse> SaveBlobStateAsync(string id, BinaryData data, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateReference, BinaryData, bool, bool?, int?)

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 StateResponse SaveBlobState(StateReference stateReference, BinaryData data, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
System.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateReference, BinaryData, bool, bool?, int?)

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 Task<StateResponse> SaveBlobStateAsync(StateReference stateReference, BinaryData data, bool overwrite = false, bool? sensitive = null, int? ttlSeconds = null)

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.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existings blobs be overwritten. Default is false.
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateInput, BinaryData, bool, string)

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 StateResponse SaveBlobState(StateInput input, BinaryData data, bool overwrite = false, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existing blobs be overwritten. Default is false.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateInput, BinaryData, bool, string)

Saves a new blob state entry asynchronously.

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

Declaration

public Task<StateResponse> SaveBlobStateAsync(StateInput input, BinaryData data, bool overwrite = false, string storeName = null)

Returns

System.Threading.Tasks.Task<Taskurai.Models.StateResponse>: A task that represents the asynchronous operation. The task result contains a Taskurai.Models.StateResponse.

Parameters

Type	Name	Description
Taskurai.Models.StateInput	input	Taskurai.Models.StateInput.
System.BinaryData	data	A System.BinaryData containing the content to upload.
System.Boolean	overwrite	Should existing blobs be overwritten. Default is false.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(string, BinaryData, BlobUploadOptions, bool?, int?, string)

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 StateResponse SaveBlobState(string id, BinaryData data, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(string, BinaryData, BlobUploadOptions, bool?, int?, string)

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 Task<StateResponse> SaveBlobStateAsync(string id, BinaryData data, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateReference, BinaryData, BlobUploadOptions, bool?, int?)

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 StateResponse SaveBlobState(StateReference stateReference, BinaryData data, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
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.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateReference, BinaryData, BlobUploadOptions, bool?, int?)

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 Task<StateResponse> SaveBlobStateAsync(StateReference stateReference, BinaryData data, BlobUploadOptions options, bool? sensitive = null, int? ttlSeconds = null)

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.BinaryData	data	A System.BinaryData containing the content to upload.
Azure.Storage.Blobs.Models.BlobUploadOptions	options	Upload options. Azure.Storage.Blobs.Models.BlobUploadOptions
System.Nullable<System.Boolean>	sensitive	The state entry includes sensitive information.
System.Nullable<System.Int32>	ttlSeconds	Time to live (automatic cleanup) seconds.

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobState(StateInput, BinaryData, BlobUploadOptions, string)

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 StateResponse SaveBlobState(StateInput input, BinaryData data, BlobUploadOptions options, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse.

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBlobStateAsync(StateInput, BinaryData, BlobUploadOptions, string)

Saves a new blob state entry asynchronously.

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

Declaration

public Task<StateResponse> SaveBlobStateAsync(StateInput input, BinaryData data, BlobUploadOptions options, string storeName = null)

Returns

System.Threading.Tasks.Task<Taskurai.Models.StateResponse>: A task that represents the asynchronous operation. The task result contains a Taskurai.Models.StateResponse.

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, string, bool)

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

Declaration

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

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, string, bool)

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

Declaration

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

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, string, BlobUploadOptions)

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

Declaration

public Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, string filePath, BlobUploadOptions options)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, string, BlobUploadOptions)

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

Declaration

public Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, string filePath, BlobUploadOptions options)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, Stream, bool)

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

Declaration

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

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, Stream, bool)

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

Declaration

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

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, Stream, BlobUploadOptions)

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

Declaration

public Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, Stream content, BlobUploadOptions options)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, Stream, BlobUploadOptions)

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

Declaration

public Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, Stream content, BlobUploadOptions options)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, BinaryData, bool)

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

Declaration

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

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, BinaryData, bool)

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

Declaration

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

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlob(StateResponse, BinaryData, BlobUploadOptions)

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

Declaration

public Response<BlobContentInfo> UploadBlob(StateResponse stateResponse, BinaryData content, BlobUploadOptions options)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

UploadBlobAsync(StateResponse, BinaryData, BlobUploadOptions)

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

Declaration

public Task<Response<BlobContentInfo>> UploadBlobAsync(StateResponse stateResponse, BinaryData content, BlobUploadOptions options)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBulkState(StateBulkInput, string)

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 IEnumerable<StateResponse> SaveBulkState(StateBulkInput input, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateBulkInput	input	Taskurai.Models.StateBulkInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

SaveBulkStateAsync(StateBulkInput, string)

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 Task<IEnumerable<StateResponse>> SaveBulkStateAsync(StateBulkInput input, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateBulkInput	input	Taskurai.Models.StateBulkInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

BulkTransaction(StateBulkTransactionInput, string)

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 IEnumerable<StateResponse> BulkTransaction(StateBulkTransactionInput input, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateBulkTransactionInput	input	Taskurai.Models.StateBulkTransactionInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

BulkTransactionAsync(StateBulkTransactionInput, string)

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 Task<IEnumerable<StateResponse>> BulkTransactionAsync(StateBulkTransactionInput input, string storeName = null)

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
Taskurai.Models.StateBulkTransactionInput	input	Taskurai.Models.StateBulkTransactionInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListState<T>(StateListInput, JsonSerializerOptions, string)

Enumerate state.

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

Declaration

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

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStateAsync<T>(StateListInput, JsonSerializerOptions, string)

Enumerate state.

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

Declaration

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

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListState(StateListInput, string)

Enumerate state.

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

Declaration

public Pageable<StateResponse> ListState(StateListInput input = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

ListStateAsync(StateListInput, string)

Enumerate state.

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

Declaration

public AsyncPageable<StateResponse> ListStateAsync(StateListInput input = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateListInput	input	Taskurai.Models.StateListInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

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

Get a state entry.

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

Declaration

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

Returns

<T>: State data.

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

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

Get a state entry.

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

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetState<T>(StateReference, StateGetOptions, JsonSerializerOptions)

Get a state entry.

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

Declaration

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

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.

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetStateAsync<T>(StateReference, StateGetOptions, JsonSerializerOptions)

Get a state entry.

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

Declaration

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

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.

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetState(string, StateGetOptions, string)

Get a state entry.

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

Declaration

public StateResponse GetState(string id, StateGetOptions options = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetStateAsync(string, StateGetOptions, string)

Get a state entry.

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

Declaration

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

Returns

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

Parameters

Type	Name	Description
System.String	id	State entry id (only alphanumeric characters, dot, underscore and hyphens are allowed).
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetState(StateReference, StateGetOptions)

Get a state entry.

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

Declaration

public StateResponse GetState(StateReference stateReference, StateGetOptions options = null)

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetStateAsync(StateReference, StateGetOptions)

Get a state entry.

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

Declaration

public Task<StateResponse> GetStateAsync(StateReference stateReference, StateGetOptions options = null)

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

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

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 StateResponse GetBlobStateTo(string id, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

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

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 Task<StateResponse> GetBlobStateToAsync(string id, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateTo(StateReference, string, StateGetOptions, BlobDownloadToOptions)

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 StateResponse GetBlobStateTo(StateReference stateReference, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateToAsync(StateReference, string, StateGetOptions, BlobDownloadToOptions)

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 Task<StateResponse> GetBlobStateToAsync(StateReference stateReference, string filePath, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

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

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 StateResponse GetBlobStateTo(string id, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, string storeName = null)

Returns

Taskurai.Models.StateResponse: Taskurai.Models.StateResponse

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

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

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 Task<StateResponse> GetBlobStateToAsync(string id, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
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.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateTo(StateReference, Stream, StateGetOptions, BlobDownloadToOptions)

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 StateResponse GetBlobStateTo(StateReference stateReference, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateToAsync(StateReference, Stream, StateGetOptions, BlobDownloadToOptions)

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 Task<StateResponse> GetBlobStateToAsync(StateReference stateReference, Stream destination, StateGetOptions options = null, BlobDownloadToOptions downloadOptions = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContent(string, StateGetOptions, BlobDownloadOptions, string)

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 StateDownloadResponse GetBlobStateContent(string id, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null, string storeName = null)

Returns

Taskurai.Models.StateDownloadResponse: Taskurai.Models.StateDownloadResponse

Parameters

Type	Name	Description
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContentAsync(string, StateGetOptions, BlobDownloadOptions, string)

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 Task<StateDownloadResponse> GetBlobStateContentAsync(string id, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
System.String	id	State ID.
Taskurai.Models.StateGetOptions	options	Taskurai.Models.StateGetOptions.
Azure.Storage.Blobs.Models.BlobDownloadOptions	downloadOptions	Azure.Storage.Blobs.Models.BlobDownloadOptions
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContent(StateReference, StateGetOptions, BlobDownloadOptions)

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 StateDownloadResponse GetBlobStateContent(StateReference stateReference, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBlobStateContentAsync(StateReference, StateGetOptions, BlobDownloadOptions)

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 Task<StateDownloadResponse> GetBlobStateContentAsync(StateReference stateReference, StateGetOptions options = null, BlobDownloadOptions downloadOptions = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobTo(StateResponse, string, BlobDownloadToOptions)

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

Declaration

public Response DownloadBlobTo(StateResponse stateResponse, string filePath, BlobDownloadToOptions options = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobToAsync(StateResponse, string, BlobDownloadToOptions)

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

Declaration

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

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobTo(StateResponse, Stream, BlobDownloadToOptions)

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

Declaration

public Response DownloadBlobTo(StateResponse stateResponse, Stream destination, BlobDownloadToOptions options = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobToAsync(StateResponse, Stream, BlobDownloadToOptions)

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

Declaration

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

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobContent(StateResponse, BlobDownloadOptions)

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

Declaration

public Response<BlobDownloadResult> DownloadBlobContent(StateResponse stateResponse, BlobDownloadOptions downloadOptions = null)

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

DownloadBlobContentAsync(StateResponse, BlobDownloadOptions)

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

Declaration

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

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

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkState<T>(StateGetBulkInput, JsonSerializerOptions, string)

Get bulk state.

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

Declaration

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

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkStateAsync<T>(StateGetBulkInput, JsonSerializerOptions, string)

Get bulk state.

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

Declaration

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

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.Text.Json.JsonSerializerOptions	serializerOptions	System.Text.Json.JsonSerializerOptions.
System.String	storeName	State store name (default = worker default state store name).

Type Parameters

• T

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkState(StateGetBulkInput, string)

Get bulk state.

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

Declaration

public IEnumerable<StateResponse> GetBulkState(StateGetBulkInput input = null, string storeName = null)

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

GetBulkStateAsync(StateGetBulkInput, string)

Get bulk state.

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

Declaration

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

Returns

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

Parameters

Type	Name	Description
Taskurai.Models.StateGetBulkInput	input	Taskurai.Models.StateGetBulkInput.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteState(string, StateDeleteOptions, string)

Delete a state entry.

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

Declaration

public void DeleteState(string id, StateDeleteOptions options = null, string storeName = null)

Parameters

Type	Name	Description
System.String	id	State ID
Taskurai.Models.StateDeleteOptions	options	Taskurai.Models.StateDeleteOptions.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteStateAsync(string, StateDeleteOptions, string)

Delete a state entry.

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

Declaration

public Task DeleteStateAsync(string id, StateDeleteOptions options = null, string storeName = null)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name	Description
System.String	id	State ID
Taskurai.Models.StateDeleteOptions	options	Taskurai.Models.StateDeleteOptions.
System.String	storeName	State store name (default = worker default state store name).

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteState(StateReference, StateDeleteOptions)

Delete a state entry.

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

Declaration

public void DeleteState(StateReference stateReference, StateDeleteOptions options = null)

Parameters

Type	Name	Description
Taskurai.Models.StateReference	stateReference	State reference Taskurai.Models.StateReference.
Taskurai.Models.StateDeleteOptions	options	Taskurai.Models.StateDeleteOptions.

Exceptions

Azure.RequestFailedException
Throws if request fails.

DeleteStateAsync(StateReference, StateDeleteOptions)

Delete a state entry.

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

Declaration

public Task DeleteStateAsync(StateReference stateReference, StateDeleteOptions options = null)

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.

Exceptions

Azure.RequestFailedException
Throws if request fails.

Implements

• System.IDisposable