public class Executions.ExecutionsClient : ClientBase<Executions.ExecutionsClient>Reference documentation and code samples for the Workflow Executions v1 API class Executions.ExecutionsClient.
Client for Executions
Inheritance
object > ClientBase > ClientBaseExecutionsExecutionsClient > Executions.ExecutionsClientNamespace
Google.Cloud.Workflows.Executions.V1Assembly
Google.Cloud.Workflows.Executions.V1.dll
Constructors
ExecutionsClient()
protected ExecutionsClient()Protected parameterless constructor to allow creation of test doubles.
ExecutionsClient(CallInvoker)
public ExecutionsClient(CallInvoker callInvoker)Creates a new client for Executions that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker | CallInvokerThe callInvoker to use to make remote calls. |
ExecutionsClient(ChannelBase)
public ExecutionsClient(ChannelBase channel)Creates a new client for Executions
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
ExecutionsClient(ClientBaseConfiguration)
protected ExecutionsClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CancelExecution(CancelExecutionRequest, CallOptions)
public virtual Execution CancelExecution(CancelExecutionRequest request, CallOptions options)Cancels an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | CancelExecutionRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Execution | The response received from the server. |
CancelExecution(CancelExecutionRequest, Metadata, DateTime?, CancellationToken)
public virtual Execution CancelExecution(CancelExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Cancels an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | CancelExecutionRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Execution | The response received from the server. |
CancelExecutionAsync(CancelExecutionRequest, CallOptions)
public virtual AsyncUnaryCall<Execution> CancelExecutionAsync(CancelExecutionRequest request, CallOptions options)Cancels an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | CancelExecutionRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExecution | The call object. |
CancelExecutionAsync(CancelExecutionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Execution> CancelExecutionAsync(CancelExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Cancels an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | CancelExecutionRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExecution | The call object. |
CreateExecution(CreateExecutionRequest, CallOptions)
public virtual Execution CreateExecution(CreateExecutionRequest request, CallOptions options)Creates a new execution using the latest revision of the given workflow.
| Parameters | |
|---|---|
| Name | Description |
request | CreateExecutionRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Execution | The response received from the server. |
CreateExecution(CreateExecutionRequest, Metadata, DateTime?, CancellationToken)
public virtual Execution CreateExecution(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new execution using the latest revision of the given workflow.
| Parameters | |
|---|---|
| Name | Description |
request | CreateExecutionRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Execution | The response received from the server. |
CreateExecutionAsync(CreateExecutionRequest, CallOptions)
public virtual AsyncUnaryCall<Execution> CreateExecutionAsync(CreateExecutionRequest request, CallOptions options)Creates a new execution using the latest revision of the given workflow.
| Parameters | |
|---|---|
| Name | Description |
request | CreateExecutionRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExecution | The call object. |
CreateExecutionAsync(CreateExecutionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Execution> CreateExecutionAsync(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new execution using the latest revision of the given workflow.
| Parameters | |
|---|---|
| Name | Description |
request | CreateExecutionRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExecution | The call object. |
GetExecution(GetExecutionRequest, CallOptions)
public virtual Execution GetExecution(GetExecutionRequest request, CallOptions options)Returns an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | GetExecutionRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Execution | The response received from the server. |
GetExecution(GetExecutionRequest, Metadata, DateTime?, CancellationToken)
public virtual Execution GetExecution(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | GetExecutionRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Execution | The response received from the server. |
GetExecutionAsync(GetExecutionRequest, CallOptions)
public virtual AsyncUnaryCall<Execution> GetExecutionAsync(GetExecutionRequest request, CallOptions options)Returns an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | GetExecutionRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExecution | The call object. |
GetExecutionAsync(GetExecutionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Execution> GetExecutionAsync(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request | GetExecutionRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExecution | The call object. |
ListExecutions(ListExecutionsRequest, CallOptions)
public virtual ListExecutionsResponse ListExecutions(ListExecutionsRequest request, CallOptions options)Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
| Parameters | |
|---|---|
| Name | Description |
request | ListExecutionsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListExecutionsResponse | The response received from the server. |
ListExecutions(ListExecutionsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListExecutionsResponse ListExecutions(ListExecutionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
| Parameters | |
|---|---|
| Name | Description |
request | ListExecutionsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListExecutionsResponse | The response received from the server. |
ListExecutionsAsync(ListExecutionsRequest, CallOptions)
public virtual AsyncUnaryCall<ListExecutionsResponse> ListExecutionsAsync(ListExecutionsRequest request, CallOptions options)Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
| Parameters | |
|---|---|
| Name | Description |
request | ListExecutionsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListExecutionsResponse | The call object. |
ListExecutionsAsync(ListExecutionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListExecutionsResponse> ListExecutionsAsync(ListExecutionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
| Parameters | |
|---|---|
| Name | Description |
request | ListExecutionsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListExecutionsResponse | The call object. |
NewInstance(ClientBaseConfiguration)
protected override Executions.ExecutionsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
ExecutionsExecutionsClient | |