Table of Contents

Class WorkManager.WorkManagerClient

Namespace
Virtufin.WorkManager.Protos
Assembly
Virtufin.WorkManager.Protos.dll

Client for WorkManager

public class WorkManager.WorkManagerClient : ClientBase<WorkManager.WorkManagerClient>
Inheritance
WorkManager.WorkManagerClient
Inherited Members

Constructors

WorkManagerClient()

Protected parameterless constructor to allow creation of test doubles.

protected WorkManagerClient()

WorkManagerClient(CallInvoker)

Creates a new client for WorkManager that uses a custom CallInvoker.

public WorkManagerClient(CallInvoker callInvoker)

Parameters

callInvoker CallInvoker

The callInvoker to use to make remote calls.

WorkManagerClient(ChannelBase)

Creates a new client for WorkManager

public WorkManagerClient(ChannelBase channel)

Parameters

channel ChannelBase

The channel to use to make remote calls.

WorkManagerClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

protected WorkManagerClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateWorker(CreateWorkerRequest, CallOptions)

public virtual CreateWorkerResponse CreateWorker(CreateWorkerRequest request, CallOptions options)

Parameters

request CreateWorkerRequest
options CallOptions

Returns

CreateWorkerResponse

CreateWorker(CreateWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual CreateWorkerResponse CreateWorker(CreateWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request CreateWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

CreateWorkerResponse

CreateWorkerAsync(CreateWorkerRequest, CallOptions)

public virtual AsyncUnaryCall<CreateWorkerResponse> CreateWorkerAsync(CreateWorkerRequest request, CallOptions options)

Parameters

request CreateWorkerRequest
options CallOptions

Returns

AsyncUnaryCall<CreateWorkerResponse>

CreateWorkerAsync(CreateWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CreateWorkerResponse> CreateWorkerAsync(CreateWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request CreateWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<CreateWorkerResponse>

DeleteWorker(DeleteWorkerRequest, CallOptions)

public virtual DeleteWorkerResponse DeleteWorker(DeleteWorkerRequest request, CallOptions options)

Parameters

request DeleteWorkerRequest
options CallOptions

Returns

DeleteWorkerResponse

DeleteWorker(DeleteWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual DeleteWorkerResponse DeleteWorker(DeleteWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request DeleteWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

DeleteWorkerResponse

DeleteWorkerAsync(DeleteWorkerRequest, CallOptions)

public virtual AsyncUnaryCall<DeleteWorkerResponse> DeleteWorkerAsync(DeleteWorkerRequest request, CallOptions options)

Parameters

request DeleteWorkerRequest
options CallOptions

Returns

AsyncUnaryCall<DeleteWorkerResponse>

DeleteWorkerAsync(DeleteWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeleteWorkerResponse> DeleteWorkerAsync(DeleteWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request DeleteWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<DeleteWorkerResponse>

GetTag(GetTagRequest, CallOptions)

public virtual GetTagResponse GetTag(GetTagRequest request, CallOptions options)

Parameters

request GetTagRequest
options CallOptions

Returns

GetTagResponse

GetTag(GetTagRequest, Metadata, DateTime?, CancellationToken)

public virtual GetTagResponse GetTag(GetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetTagRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

GetTagResponse

GetTagAsync(GetTagRequest, CallOptions)

public virtual AsyncUnaryCall<GetTagResponse> GetTagAsync(GetTagRequest request, CallOptions options)

Parameters

request GetTagRequest
options CallOptions

Returns

AsyncUnaryCall<GetTagResponse>

GetTagAsync(GetTagRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetTagResponse> GetTagAsync(GetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetTagRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<GetTagResponse>

GetTags(GetTagsRequest, CallOptions)

public virtual GetTagsResponse GetTags(GetTagsRequest request, CallOptions options)

Parameters

request GetTagsRequest
options CallOptions

Returns

GetTagsResponse

GetTags(GetTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual GetTagsResponse GetTags(GetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetTagsRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

GetTagsResponse

GetTagsAsync(GetTagsRequest, CallOptions)

public virtual AsyncUnaryCall<GetTagsResponse> GetTagsAsync(GetTagsRequest request, CallOptions options)

Parameters

request GetTagsRequest
options CallOptions

Returns

AsyncUnaryCall<GetTagsResponse>

GetTagsAsync(GetTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetTagsResponse> GetTagsAsync(GetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetTagsRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<GetTagsResponse>

GetWorkerHistory(GetWorkerHistoryRequest, CallOptions)

public virtual GetWorkerHistoryResponse GetWorkerHistory(GetWorkerHistoryRequest request, CallOptions options)

Parameters

request GetWorkerHistoryRequest
options CallOptions

Returns

GetWorkerHistoryResponse

GetWorkerHistory(GetWorkerHistoryRequest, Metadata, DateTime?, CancellationToken)

public virtual GetWorkerHistoryResponse GetWorkerHistory(GetWorkerHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetWorkerHistoryRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

GetWorkerHistoryResponse

GetWorkerHistoryAsync(GetWorkerHistoryRequest, CallOptions)

public virtual AsyncUnaryCall<GetWorkerHistoryResponse> GetWorkerHistoryAsync(GetWorkerHistoryRequest request, CallOptions options)

Parameters

request GetWorkerHistoryRequest
options CallOptions

Returns

AsyncUnaryCall<GetWorkerHistoryResponse>

GetWorkerHistoryAsync(GetWorkerHistoryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetWorkerHistoryResponse> GetWorkerHistoryAsync(GetWorkerHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request GetWorkerHistoryRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<GetWorkerHistoryResponse>

InvokeWorkerCommand(InvokeWorkerCommandRequest, CallOptions)

Hand a started worker one command synchronously: the command becomes a CloudEvent (ce-type com.virtufin.workmanager.worker.command, extension command), goes through the worker's ProcessAsync like any input (its config and secrets stamped, serialized with its inbox by the actor), and the worker's outputs come back here instead of being published.

public virtual InvokeWorkerCommandResponse InvokeWorkerCommand(InvokeWorkerCommandRequest request, CallOptions options)

Parameters

request InvokeWorkerCommandRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns

InvokeWorkerCommandResponse

The response received from the server.

InvokeWorkerCommand(InvokeWorkerCommandRequest, Metadata, DateTime?, CancellationToken)

Hand a started worker one command synchronously: the command becomes a CloudEvent (ce-type com.virtufin.workmanager.worker.command, extension command), goes through the worker's ProcessAsync like any input (its config and secrets stamped, serialized with its inbox by the actor), and the worker's outputs come back here instead of being published.

public virtual InvokeWorkerCommandResponse InvokeWorkerCommand(InvokeWorkerCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InvokeWorkerCommandRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime?

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns

InvokeWorkerCommandResponse

The response received from the server.

InvokeWorkerCommandAsync(InvokeWorkerCommandRequest, CallOptions)

Hand a started worker one command synchronously: the command becomes a CloudEvent (ce-type com.virtufin.workmanager.worker.command, extension command), goes through the worker's ProcessAsync like any input (its config and secrets stamped, serialized with its inbox by the actor), and the worker's outputs come back here instead of being published.

public virtual AsyncUnaryCall<InvokeWorkerCommandResponse> InvokeWorkerCommandAsync(InvokeWorkerCommandRequest request, CallOptions options)

Parameters

request InvokeWorkerCommandRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns

AsyncUnaryCall<InvokeWorkerCommandResponse>

The call object.

InvokeWorkerCommandAsync(InvokeWorkerCommandRequest, Metadata, DateTime?, CancellationToken)

Hand a started worker one command synchronously: the command becomes a CloudEvent (ce-type com.virtufin.workmanager.worker.command, extension command), goes through the worker's ProcessAsync like any input (its config and secrets stamped, serialized with its inbox by the actor), and the worker's outputs come back here instead of being published.

public virtual AsyncUnaryCall<InvokeWorkerCommandResponse> InvokeWorkerCommandAsync(InvokeWorkerCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request InvokeWorkerCommandRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime?

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns

AsyncUnaryCall<InvokeWorkerCommandResponse>

The call object.

ListWorkers(ListWorkersRequest, CallOptions)

public virtual ListWorkersResponse ListWorkers(ListWorkersRequest request, CallOptions options)

Parameters

request ListWorkersRequest
options CallOptions

Returns

ListWorkersResponse

ListWorkers(ListWorkersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListWorkersResponse ListWorkers(ListWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request ListWorkersRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

ListWorkersResponse

ListWorkersAsync(ListWorkersRequest, CallOptions)

public virtual AsyncUnaryCall<ListWorkersResponse> ListWorkersAsync(ListWorkersRequest request, CallOptions options)

Parameters

request ListWorkersRequest
options CallOptions

Returns

AsyncUnaryCall<ListWorkersResponse>

ListWorkersAsync(ListWorkersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListWorkersResponse> ListWorkersAsync(ListWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request ListWorkersRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<ListWorkersResponse>

LoadCode(LoadCodeRequest, CallOptions)

public virtual LoadCodeResponse LoadCode(LoadCodeRequest request, CallOptions options)

Parameters

request LoadCodeRequest
options CallOptions

Returns

LoadCodeResponse

LoadCode(LoadCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual LoadCodeResponse LoadCode(LoadCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request LoadCodeRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

LoadCodeResponse

LoadCodeAsync(LoadCodeRequest, CallOptions)

public virtual AsyncUnaryCall<LoadCodeResponse> LoadCodeAsync(LoadCodeRequest request, CallOptions options)

Parameters

request LoadCodeRequest
options CallOptions

Returns

AsyncUnaryCall<LoadCodeResponse>

LoadCodeAsync(LoadCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LoadCodeResponse> LoadCodeAsync(LoadCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request LoadCodeRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<LoadCodeResponse>

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

protected override WorkManager.WorkManagerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration

Returns

WorkManager.WorkManagerClient

RecoverWorkers(RecoverWorkersRequest, CallOptions)

public virtual RecoverWorkersResponse RecoverWorkers(RecoverWorkersRequest request, CallOptions options)

Parameters

request RecoverWorkersRequest
options CallOptions

Returns

RecoverWorkersResponse

RecoverWorkers(RecoverWorkersRequest, Metadata, DateTime?, CancellationToken)

public virtual RecoverWorkersResponse RecoverWorkers(RecoverWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request RecoverWorkersRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

RecoverWorkersResponse

RecoverWorkersAsync(RecoverWorkersRequest, CallOptions)

public virtual AsyncUnaryCall<RecoverWorkersResponse> RecoverWorkersAsync(RecoverWorkersRequest request, CallOptions options)

Parameters

request RecoverWorkersRequest
options CallOptions

Returns

AsyncUnaryCall<RecoverWorkersResponse>

RecoverWorkersAsync(RecoverWorkersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RecoverWorkersResponse> RecoverWorkersAsync(RecoverWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request RecoverWorkersRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<RecoverWorkersResponse>

SetTag(SetTagRequest, CallOptions)

public virtual SetTagResponse SetTag(SetTagRequest request, CallOptions options)

Parameters

request SetTagRequest
options CallOptions

Returns

SetTagResponse

SetTag(SetTagRequest, Metadata, DateTime?, CancellationToken)

public virtual SetTagResponse SetTag(SetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request SetTagRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

SetTagResponse

SetTagAsync(SetTagRequest, CallOptions)

public virtual AsyncUnaryCall<SetTagResponse> SetTagAsync(SetTagRequest request, CallOptions options)

Parameters

request SetTagRequest
options CallOptions

Returns

AsyncUnaryCall<SetTagResponse>

SetTagAsync(SetTagRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SetTagResponse> SetTagAsync(SetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request SetTagRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<SetTagResponse>

SetTags(SetTagsRequest, CallOptions)

public virtual SetTagsResponse SetTags(SetTagsRequest request, CallOptions options)

Parameters

request SetTagsRequest
options CallOptions

Returns

SetTagsResponse

SetTags(SetTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual SetTagsResponse SetTags(SetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request SetTagsRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

SetTagsResponse

SetTagsAsync(SetTagsRequest, CallOptions)

public virtual AsyncUnaryCall<SetTagsResponse> SetTagsAsync(SetTagsRequest request, CallOptions options)

Parameters

request SetTagsRequest
options CallOptions

Returns

AsyncUnaryCall<SetTagsResponse>

SetTagsAsync(SetTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SetTagsResponse> SetTagsAsync(SetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request SetTagsRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<SetTagsResponse>

StartWorker(StartWorkerRequest, CallOptions)

public virtual StartWorkerResponse StartWorker(StartWorkerRequest request, CallOptions options)

Parameters

request StartWorkerRequest
options CallOptions

Returns

StartWorkerResponse

StartWorker(StartWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual StartWorkerResponse StartWorker(StartWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request StartWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

StartWorkerResponse

StartWorkerAsync(StartWorkerRequest, CallOptions)

public virtual AsyncUnaryCall<StartWorkerResponse> StartWorkerAsync(StartWorkerRequest request, CallOptions options)

Parameters

request StartWorkerRequest
options CallOptions

Returns

AsyncUnaryCall<StartWorkerResponse>

StartWorkerAsync(StartWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StartWorkerResponse> StartWorkerAsync(StartWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request StartWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<StartWorkerResponse>

StopWorker(StopWorkerRequest, CallOptions)

public virtual StopWorkerResponse StopWorker(StopWorkerRequest request, CallOptions options)

Parameters

request StopWorkerRequest
options CallOptions

Returns

StopWorkerResponse

StopWorker(StopWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual StopWorkerResponse StopWorker(StopWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request StopWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

StopWorkerResponse

StopWorkerAsync(StopWorkerRequest, CallOptions)

public virtual AsyncUnaryCall<StopWorkerResponse> StopWorkerAsync(StopWorkerRequest request, CallOptions options)

Parameters

request StopWorkerRequest
options CallOptions

Returns

AsyncUnaryCall<StopWorkerResponse>

StopWorkerAsync(StopWorkerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StopWorkerResponse> StopWorkerAsync(StopWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request StopWorkerRequest
headers Metadata
deadline DateTime?
cancellationToken CancellationToken

Returns

AsyncUnaryCall<StopWorkerResponse>