Class Executions.ExecutionsClient

public class ExecutionsClient : ClientBase<Executions.ExecutionsClient>

Client for Executions

Inheritance

Object > ClientBase > ClientBase<Executions.ExecutionsClient> > Executions.ExecutionsClient

Namespace

Google.Cloud.Workflows.Executions.V1

Assembly

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

The callInvoker to use to make remote calls.

ExecutionsClient(ChannelBase)

public ExecutionsClient(ChannelBase channel)

Creates a new client for Executions

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ExecutionsClient(ClientBase.ClientBaseConfiguration)

protected ExecutionsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CancelExecution(CancelExecutionRequest, CallOptions)

public virtual Execution CancelExecution(CancelExecutionRequest request, CallOptions options)

Cancels an execution of the given name.

Parameters
NameDescription
requestCancelExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Execution

The response received from the server.

CancelExecution(CancelExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Execution CancelExecution(CancelExecutionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Cancels an execution of the given name.

Parameters
NameDescription
requestCancelExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCancelExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

The call object.

CancelExecutionAsync(CancelExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Execution> CancelExecutionAsync(CancelExecutionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Cancels an execution of the given name.

Parameters
NameDescription
requestCancelExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Execution

The response received from the server.

CreateExecution(CreateExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Execution CreateExecution(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new execution using the latest revision of the given workflow.

Parameters
NameDescription
requestCreateExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

The call object.

CreateExecutionAsync(CreateExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Execution> CreateExecutionAsync(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new execution using the latest revision of the given workflow.

Parameters
NameDescription
requestCreateExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

The call object.

GetExecution(GetExecutionRequest, CallOptions)

public virtual Execution GetExecution(GetExecutionRequest request, CallOptions options)

Returns an execution of the given name.

Parameters
NameDescription
requestGetExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Execution

The response received from the server.

GetExecution(GetExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Execution GetExecution(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns an execution of the given name.

Parameters
NameDescription
requestGetExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

The call object.

GetExecutionAsync(GetExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Execution> GetExecutionAsync(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns an execution of the given name.

Parameters
NameDescription
requestGetExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListExecutionsResponse

The response received from the server.

ListExecutions(ListExecutionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListExecutionsResponse ListExecutions(ListExecutionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListExecutionsResponse>

The call object.

ListExecutionsAsync(ListExecutionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListExecutionsResponse> ListExecutionsAsync(ListExecutionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListExecutionsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Executions.ExecutionsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Executions.ExecutionsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Workflows.Executions.V1.Executions.ExecutionsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)