Workflow Executions v1 API - Class ExecutionsClientImpl (2.1.0) 

public sealed class ExecutionsClientImpl : ExecutionsClient

Reference documentation and code samples for the Workflow Executions v1 API class ExecutionsClientImpl.

Executions client wrapper implementation, for convenient use.

Inheritance

object > ExecutionsClient > ExecutionsClientImpl

Namespace

GoogleGoogle.CloudGoogle.Cloud.WorkflowsGoogle.Cloud.Workflows.ExecutionsV1

Assembly

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
NameDescription
grpcClientExecutionsExecutionsClient

The underlying gRPC client.

settingsExecutionsSettings

The base ExecutionsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Executions.ExecutionsClient GrpcClient { get; }

The underlying gRPC Executions client

Property Value
TypeDescription
ExecutionsExecutionsClient
Overrides

Methods

CancelExecution(CancelExecutionRequest, CallSettings)

public override Execution CancelExecution(CancelExecutionRequest request, CallSettings callSettings = null)

Cancels an execution of the given name.

Parameters
NameDescription
requestCancelExecutionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Execution

The RPC response.

Overrides

CancelExecutionAsync(CancelExecutionRequest, CallSettings)

public override Task<Execution> CancelExecutionAsync(CancelExecutionRequest request, CallSettings callSettings = null)

Cancels an execution of the given name.

Parameters
NameDescription
requestCancelExecutionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskExecution

A Task containing the RPC response.

Overrides

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
NameDescription
requestCreateExecutionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Execution

The RPC response.

Overrides

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
NameDescription
requestCreateExecutionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskExecution

A Task containing the RPC response.

Overrides

GetExecution(GetExecutionRequest, CallSettings)

public override Execution GetExecution(GetExecutionRequest request, CallSettings callSettings = null)

Returns an execution of the given name.

Parameters
NameDescription
requestGetExecutionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Execution

The RPC response.

Overrides

GetExecutionAsync(GetExecutionRequest, CallSettings)

public override Task<Execution> GetExecutionAsync(GetExecutionRequest request, CallSettings callSettings = null)

Returns an execution of the given name.

Parameters
NameDescription
requestGetExecutionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskExecution

A Task containing the RPC response.

Overrides

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
NameDescription
requestListExecutionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListExecutionsResponseExecution

A pageable sequence of Execution resources.

Overrides

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
NameDescription
requestListExecutionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListExecutionsResponseExecution

A pageable asynchronous sequence of Execution resources.

Overrides