public sealed class ExecutionsClientImpl : ExecutionsClientReference documentation and code samples for the Workflow Executions v1 API class ExecutionsClientImpl.
Executions client wrapper implementation, for convenient use.
Namespace
GoogleGoogle.CloudGoogle.Cloud.WorkflowsGoogle.Cloud.Workflows.ExecutionsV1Assembly
Google.Cloud.Workflows.Executions.V1.dll
Remarks
Executions is used to start and manage running instances of [Workflows][google.cloud.workflows.v1.Workflow] called executions.
Constructors
ExecutionsClientImpl(ExecutionsClient, ExecutionsSettings, ILogger)
public ExecutionsClientImpl(Executions.ExecutionsClient grpcClient, ExecutionsSettings settings, ILogger logger)Constructs a client wrapper for the Executions service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
ExecutionsExecutionsClientThe underlying gRPC client. |
settings |
ExecutionsSettingsThe base ExecutionsSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override Executions.ExecutionsClient GrpcClient { get; }The underlying gRPC Executions client
| Property Value | |
|---|---|
| Type | Description |
ExecutionsExecutionsClient |
|
Methods
CancelExecution(CancelExecutionRequest, CallSettings)
public override Execution CancelExecution(CancelExecutionRequest request, CallSettings callSettings = null)Cancels an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request |
CancelExecutionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Execution |
The RPC response. |
CancelExecutionAsync(CancelExecutionRequest, CallSettings)
public override Task<Execution> CancelExecutionAsync(CancelExecutionRequest request, CallSettings callSettings = null)Cancels an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request |
CancelExecutionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskExecution |
A Task containing the RPC response. |
CreateExecution(CreateExecutionRequest, CallSettings)
public override Execution CreateExecution(CreateExecutionRequest request, CallSettings callSettings = null)Creates a new execution using the latest revision of the given workflow.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateExecutionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Execution |
The RPC response. |
CreateExecutionAsync(CreateExecutionRequest, CallSettings)
public override Task<Execution> CreateExecutionAsync(CreateExecutionRequest request, CallSettings callSettings = null)Creates a new execution using the latest revision of the given workflow.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateExecutionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskExecution |
A Task containing the RPC response. |
GetExecution(GetExecutionRequest, CallSettings)
public override Execution GetExecution(GetExecutionRequest request, CallSettings callSettings = null)Returns an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetExecutionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Execution |
The RPC response. |
GetExecutionAsync(GetExecutionRequest, CallSettings)
public override Task<Execution> GetExecutionAsync(GetExecutionRequest request, CallSettings callSettings = null)Returns an execution of the given name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetExecutionRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskExecution |
A Task containing the RPC response. |
ListExecutions(ListExecutionsRequest, CallSettings)
public override PagedEnumerable<ListExecutionsResponse, Execution> ListExecutions(ListExecutionsRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListExecutionsResponseExecution |
A pageable sequence of Execution resources. |
ListExecutionsAsync(ListExecutionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListExecutionsResponse, Execution> ListExecutionsAsync(ListExecutionsRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListExecutionsResponseExecution |
A pageable asynchronous sequence of Execution resources. |