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
callInvokerCallInvokerThe callInvoker to use to make remote calls.
WorkManagerClient(ChannelBase)
Creates a new client for WorkManager
public WorkManagerClient(ChannelBase channel)
Parameters
channelChannelBaseThe channel to use to make remote calls.
WorkManagerClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
protected WorkManagerClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
configurationClientBase.ClientBaseConfigurationThe client configuration.
Methods
CreateWorker(CreateWorkerRequest, CallOptions)
public virtual CreateWorkerResponse CreateWorker(CreateWorkerRequest request, CallOptions options)
Parameters
requestCreateWorkerRequestoptionsCallOptions
Returns
CreateWorker(CreateWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual CreateWorkerResponse CreateWorker(CreateWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestCreateWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
CreateWorkerAsync(CreateWorkerRequest, CallOptions)
public virtual AsyncUnaryCall<CreateWorkerResponse> CreateWorkerAsync(CreateWorkerRequest request, CallOptions options)
Parameters
requestCreateWorkerRequestoptionsCallOptions
Returns
CreateWorkerAsync(CreateWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<CreateWorkerResponse> CreateWorkerAsync(CreateWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestCreateWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
DeleteWorker(DeleteWorkerRequest, CallOptions)
public virtual DeleteWorkerResponse DeleteWorker(DeleteWorkerRequest request, CallOptions options)
Parameters
requestDeleteWorkerRequestoptionsCallOptions
Returns
DeleteWorker(DeleteWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual DeleteWorkerResponse DeleteWorker(DeleteWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestDeleteWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
DeleteWorkerAsync(DeleteWorkerRequest, CallOptions)
public virtual AsyncUnaryCall<DeleteWorkerResponse> DeleteWorkerAsync(DeleteWorkerRequest request, CallOptions options)
Parameters
requestDeleteWorkerRequestoptionsCallOptions
Returns
DeleteWorkerAsync(DeleteWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DeleteWorkerResponse> DeleteWorkerAsync(DeleteWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestDeleteWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
GetTag(GetTagRequest, CallOptions)
public virtual GetTagResponse GetTag(GetTagRequest request, CallOptions options)
Parameters
requestGetTagRequestoptionsCallOptions
Returns
GetTag(GetTagRequest, Metadata, DateTime?, CancellationToken)
public virtual GetTagResponse GetTag(GetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestGetTagRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
GetTagAsync(GetTagRequest, CallOptions)
public virtual AsyncUnaryCall<GetTagResponse> GetTagAsync(GetTagRequest request, CallOptions options)
Parameters
requestGetTagRequestoptionsCallOptions
Returns
GetTagAsync(GetTagRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<GetTagResponse> GetTagAsync(GetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestGetTagRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
GetTags(GetTagsRequest, CallOptions)
public virtual GetTagsResponse GetTags(GetTagsRequest request, CallOptions options)
Parameters
requestGetTagsRequestoptionsCallOptions
Returns
GetTags(GetTagsRequest, Metadata, DateTime?, CancellationToken)
public virtual GetTagsResponse GetTags(GetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestGetTagsRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
GetTagsAsync(GetTagsRequest, CallOptions)
public virtual AsyncUnaryCall<GetTagsResponse> GetTagsAsync(GetTagsRequest request, CallOptions options)
Parameters
requestGetTagsRequestoptionsCallOptions
Returns
GetTagsAsync(GetTagsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<GetTagsResponse> GetTagsAsync(GetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestGetTagsRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
GetWorkerHistory(GetWorkerHistoryRequest, CallOptions)
public virtual GetWorkerHistoryResponse GetWorkerHistory(GetWorkerHistoryRequest request, CallOptions options)
Parameters
requestGetWorkerHistoryRequestoptionsCallOptions
Returns
GetWorkerHistory(GetWorkerHistoryRequest, Metadata, DateTime?, CancellationToken)
public virtual GetWorkerHistoryResponse GetWorkerHistory(GetWorkerHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestGetWorkerHistoryRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
GetWorkerHistoryAsync(GetWorkerHistoryRequest, CallOptions)
public virtual AsyncUnaryCall<GetWorkerHistoryResponse> GetWorkerHistoryAsync(GetWorkerHistoryRequest request, CallOptions options)
Parameters
requestGetWorkerHistoryRequestoptionsCallOptions
Returns
GetWorkerHistoryAsync(GetWorkerHistoryRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<GetWorkerHistoryResponse> GetWorkerHistoryAsync(GetWorkerHistoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestGetWorkerHistoryRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
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
requestInvokeWorkerCommandRequestThe request to send to the server.
optionsCallOptionsThe 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
requestInvokeWorkerCommandRequestThe request to send to the server.
headersMetadataThe initial metadata to send with the call. This parameter is optional.
deadlineDateTime?An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationTokenCancellationTokenAn 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
requestInvokeWorkerCommandRequestThe request to send to the server.
optionsCallOptionsThe 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
requestInvokeWorkerCommandRequestThe request to send to the server.
headersMetadataThe initial metadata to send with the call. This parameter is optional.
deadlineDateTime?An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationTokenCancellationTokenAn optional token for canceling the call.
Returns
- AsyncUnaryCall<InvokeWorkerCommandResponse>
The call object.
ListWorkers(ListWorkersRequest, CallOptions)
public virtual ListWorkersResponse ListWorkers(ListWorkersRequest request, CallOptions options)
Parameters
requestListWorkersRequestoptionsCallOptions
Returns
ListWorkers(ListWorkersRequest, Metadata, DateTime?, CancellationToken)
public virtual ListWorkersResponse ListWorkers(ListWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestListWorkersRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
ListWorkersAsync(ListWorkersRequest, CallOptions)
public virtual AsyncUnaryCall<ListWorkersResponse> ListWorkersAsync(ListWorkersRequest request, CallOptions options)
Parameters
requestListWorkersRequestoptionsCallOptions
Returns
ListWorkersAsync(ListWorkersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListWorkersResponse> ListWorkersAsync(ListWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestListWorkersRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
LoadCode(LoadCodeRequest, CallOptions)
public virtual LoadCodeResponse LoadCode(LoadCodeRequest request, CallOptions options)
Parameters
requestLoadCodeRequestoptionsCallOptions
Returns
LoadCode(LoadCodeRequest, Metadata, DateTime?, CancellationToken)
public virtual LoadCodeResponse LoadCode(LoadCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestLoadCodeRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
LoadCodeAsync(LoadCodeRequest, CallOptions)
public virtual AsyncUnaryCall<LoadCodeResponse> LoadCodeAsync(LoadCodeRequest request, CallOptions options)
Parameters
requestLoadCodeRequestoptionsCallOptions
Returns
LoadCodeAsync(LoadCodeRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<LoadCodeResponse> LoadCodeAsync(LoadCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestLoadCodeRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration.
protected override WorkManager.WorkManagerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
configurationClientBase.ClientBaseConfiguration
Returns
RecoverWorkers(RecoverWorkersRequest, CallOptions)
public virtual RecoverWorkersResponse RecoverWorkers(RecoverWorkersRequest request, CallOptions options)
Parameters
requestRecoverWorkersRequestoptionsCallOptions
Returns
RecoverWorkers(RecoverWorkersRequest, Metadata, DateTime?, CancellationToken)
public virtual RecoverWorkersResponse RecoverWorkers(RecoverWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestRecoverWorkersRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
RecoverWorkersAsync(RecoverWorkersRequest, CallOptions)
public virtual AsyncUnaryCall<RecoverWorkersResponse> RecoverWorkersAsync(RecoverWorkersRequest request, CallOptions options)
Parameters
requestRecoverWorkersRequestoptionsCallOptions
Returns
RecoverWorkersAsync(RecoverWorkersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<RecoverWorkersResponse> RecoverWorkersAsync(RecoverWorkersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestRecoverWorkersRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
SetTag(SetTagRequest, CallOptions)
public virtual SetTagResponse SetTag(SetTagRequest request, CallOptions options)
Parameters
requestSetTagRequestoptionsCallOptions
Returns
SetTag(SetTagRequest, Metadata, DateTime?, CancellationToken)
public virtual SetTagResponse SetTag(SetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestSetTagRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
SetTagAsync(SetTagRequest, CallOptions)
public virtual AsyncUnaryCall<SetTagResponse> SetTagAsync(SetTagRequest request, CallOptions options)
Parameters
requestSetTagRequestoptionsCallOptions
Returns
SetTagAsync(SetTagRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SetTagResponse> SetTagAsync(SetTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestSetTagRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
SetTags(SetTagsRequest, CallOptions)
public virtual SetTagsResponse SetTags(SetTagsRequest request, CallOptions options)
Parameters
requestSetTagsRequestoptionsCallOptions
Returns
SetTags(SetTagsRequest, Metadata, DateTime?, CancellationToken)
public virtual SetTagsResponse SetTags(SetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestSetTagsRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
SetTagsAsync(SetTagsRequest, CallOptions)
public virtual AsyncUnaryCall<SetTagsResponse> SetTagsAsync(SetTagsRequest request, CallOptions options)
Parameters
requestSetTagsRequestoptionsCallOptions
Returns
SetTagsAsync(SetTagsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SetTagsResponse> SetTagsAsync(SetTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestSetTagsRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
StartWorker(StartWorkerRequest, CallOptions)
public virtual StartWorkerResponse StartWorker(StartWorkerRequest request, CallOptions options)
Parameters
requestStartWorkerRequestoptionsCallOptions
Returns
StartWorker(StartWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual StartWorkerResponse StartWorker(StartWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestStartWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
StartWorkerAsync(StartWorkerRequest, CallOptions)
public virtual AsyncUnaryCall<StartWorkerResponse> StartWorkerAsync(StartWorkerRequest request, CallOptions options)
Parameters
requestStartWorkerRequestoptionsCallOptions
Returns
StartWorkerAsync(StartWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<StartWorkerResponse> StartWorkerAsync(StartWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestStartWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
StopWorker(StopWorkerRequest, CallOptions)
public virtual StopWorkerResponse StopWorker(StopWorkerRequest request, CallOptions options)
Parameters
requestStopWorkerRequestoptionsCallOptions
Returns
StopWorker(StopWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual StopWorkerResponse StopWorker(StopWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestStopWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken
Returns
StopWorkerAsync(StopWorkerRequest, CallOptions)
public virtual AsyncUnaryCall<StopWorkerResponse> StopWorkerAsync(StopWorkerRequest request, CallOptions options)
Parameters
requestStopWorkerRequestoptionsCallOptions
Returns
StopWorkerAsync(StopWorkerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<StopWorkerResponse> StopWorkerAsync(StopWorkerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
requestStopWorkerRequestheadersMetadatadeadlineDateTime?cancellationTokenCancellationToken