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

[BindServiceMethod(typeof(Executions), "BindService")]
public abstract class Executions.ExecutionsBase

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

Base class for server-side implementations of Executions

Inheritance

object > Executions.ExecutionsBase

Namespace

Google.Cloud.Workflows.Executions.V1

Assembly

Google.Cloud.Workflows.Executions.V1.dll

Methods

CancelExecution(CancelExecutionRequest, ServerCallContext)

public virtual Task<Execution> CancelExecution(CancelExecutionRequest request, ServerCallContext context)

Cancels an execution of the given name.

Parameters
NameDescription
requestCancelExecutionRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskExecution

The response to send back to the client (wrapped by a task).

CreateExecution(CreateExecutionRequest, ServerCallContext)

public virtual Task<Execution> CreateExecution(CreateExecutionRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestCreateExecutionRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskExecution

The response to send back to the client (wrapped by a task).

GetExecution(GetExecutionRequest, ServerCallContext)

public virtual Task<Execution> GetExecution(GetExecutionRequest request, ServerCallContext context)

Returns an execution of the given name.

Parameters
NameDescription
requestGetExecutionRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskExecution

The response to send back to the client (wrapped by a task).

ListExecutions(ListExecutionsRequest, ServerCallContext)

public virtual Task<ListExecutionsResponse> ListExecutions(ListExecutionsRequest request, ServerCallContext context)

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 received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListExecutionsResponse

The response to send back to the client (wrapped by a task).