Workflows v1beta API - Class Workflows.WorkflowsBase (2.0.0-beta02)

Version 2.0.0-beta02

• 2.0.0-beta05 (latest)
• 2.0.0-beta04
• 1.0.0-beta03

[BindServiceMethod(typeof(Workflows), "BindService")]
public abstract class Workflows.WorkflowsBase

Reference documentation and code samples for the Workflows v1beta API class Workflows.WorkflowsBase.

Base class for server-side implementations of Workflows

Inheritance

object > Workflows.WorkflowsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.WorkflowsV1Beta

Assembly

Google.Cloud.Workflows.V1Beta.dll

Methods

CreateWorkflow(CreateWorkflowRequest, ServerCallContext)

public virtual Task<Operation> CreateWorkflow(CreateWorkflowRequest request, ServerCallContext context)

Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.

Parameters
Name	Description
request	CreateWorkflowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteWorkflow(DeleteWorkflowRequest, ServerCallContext)

public virtual Task<Operation> DeleteWorkflow(DeleteWorkflowRequest request, ServerCallContext context)

Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.

Parameters
Name	Description
request	DeleteWorkflowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetWorkflow(GetWorkflowRequest, ServerCallContext)

public virtual Task<Workflow> GetWorkflow(GetWorkflowRequest request, ServerCallContext context)

Gets details of a single Workflow.

Parameters
Name	Description
request	GetWorkflowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskWorkflow	The response to send back to the client (wrapped by a task).

ListWorkflows(ListWorkflowsRequest, ServerCallContext)

public virtual Task<ListWorkflowsResponse> ListWorkflows(ListWorkflowsRequest request, ServerCallContext context)

Lists Workflows in a given project and location. The default order is not specified.

Parameters
Name	Description
request	ListWorkflowsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListWorkflowsResponse	The response to send back to the client (wrapped by a task).

UpdateWorkflow(UpdateWorkflowRequest, ServerCallContext)

public virtual Task<Operation> UpdateWorkflow(UpdateWorkflowRequest request, ServerCallContext context)

Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.

Parameters
Name	Description
request	UpdateWorkflowRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).