Workflow Executions v1 API - Class Executions.ExecutionsClient (2.5.0)

Version 2.5.0

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

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.ExecutionsClient

Inherited Members

ClientBase<Executions.ExecutionsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ExecutionsClient(ChannelBase)

public ExecutionsClient(ChannelBase channel)

Creates a new client for Executions

Parameter
Name	Description
channel	ChannelBase The 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	ClientBaseClientBaseConfiguration The 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	CancelExecutionRequest The request to send to the server.
options	CallOptions The 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	CancelExecutionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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	CancelExecutionRequest The request to send to the server.
options	CallOptions The 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	CancelExecutionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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	CreateExecutionRequest The request to send to the server.
options	CallOptions The 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	CreateExecutionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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	CreateExecutionRequest The request to send to the server.
options	CallOptions The 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	CreateExecutionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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	GetExecutionRequest The request to send to the server.
options	CallOptions The 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	GetExecutionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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	GetExecutionRequest The request to send to the server.
options	CallOptions The 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	GetExecutionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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	ListExecutionsRequest The request to send to the server.
options	CallOptions The 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	ListExecutionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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	ListExecutionsRequest The request to send to the server.
options	CallOptions The 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	ListExecutionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An 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

Overrides

ClientBase<Executions.ExecutionsClient>.NewInstance(ClientBase.ClientBaseConfiguration)