Workflows v1 API - Class Workflows.WorkflowsClient (2.1.0)

Version 2.1.0

• 2.5.0 (latest)
• 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 Workflows.WorkflowsClient : ClientBase<Workflows.WorkflowsClient>

Reference documentation and code samples for the Workflows v1 API class Workflows.WorkflowsClient.

Client for Workflows

Inheritance

object > ClientBase > ClientBaseWorkflowsWorkflowsClient > Workflows.WorkflowsClient

Inherited Members

ClientBase<Workflows.WorkflowsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.WorkflowsV1

Assembly

Google.Cloud.Workflows.V1.dll

Constructors

WorkflowsClient()

protected WorkflowsClient()

Protected parameterless constructor to allow creation of test doubles.

WorkflowsClient(CallInvoker)

public WorkflowsClient(CallInvoker callInvoker)

Creates a new client for Workflows that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

WorkflowsClient(ChannelBase)

public WorkflowsClient(ChannelBase channel)

Creates a new client for Workflows

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

WorkflowsClient(ClientBaseConfiguration)

protected WorkflowsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

CreateWorkflow(CreateWorkflowRequest, CallOptions)

public virtual Operation CreateWorkflow(CreateWorkflowRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateWorkflow(CreateWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateWorkflow(CreateWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
Operation	The response received from the server.

CreateWorkflowAsync(CreateWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateWorkflowAsync(CreateWorkflowRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateWorkflowAsync(CreateWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateWorkflowAsync(CreateWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
AsyncUnaryCallOperation	The call object.

DeleteWorkflow(DeleteWorkflowRequest, CallOptions)

public virtual Operation DeleteWorkflow(DeleteWorkflowRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteWorkflow(DeleteWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteWorkflow(DeleteWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
Operation	The response received from the server.

DeleteWorkflowAsync(DeleteWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteWorkflowAsync(DeleteWorkflowRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteWorkflowAsync(DeleteWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteWorkflowAsync(DeleteWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
AsyncUnaryCallOperation	The call object.

GetWorkflow(GetWorkflowRequest, CallOptions)

public virtual Workflow GetWorkflow(GetWorkflowRequest request, CallOptions options)

Gets details of a single Workflow.

Parameters
Name	Description
request	GetWorkflowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Workflow	The response received from the server.

GetWorkflow(GetWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual Workflow GetWorkflow(GetWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Workflow.

Parameters
Name	Description
request	GetWorkflowRequest 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
Workflow	The response received from the server.

GetWorkflowAsync(GetWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<Workflow> GetWorkflowAsync(GetWorkflowRequest request, CallOptions options)

Gets details of a single Workflow.

Parameters
Name	Description
request	GetWorkflowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallWorkflow	The call object.

GetWorkflowAsync(GetWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Workflow> GetWorkflowAsync(GetWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Workflow.

Parameters
Name	Description
request	GetWorkflowRequest 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
AsyncUnaryCallWorkflow	The call object.

ListWorkflows(ListWorkflowsRequest, CallOptions)

public virtual ListWorkflowsResponse ListWorkflows(ListWorkflowsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListWorkflowsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListWorkflowsResponse	The response received from the server.

ListWorkflows(ListWorkflowsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListWorkflowsResponse ListWorkflows(ListWorkflowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListWorkflowsRequest 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
ListWorkflowsResponse	The response received from the server.

ListWorkflowsAsync(ListWorkflowsRequest, CallOptions)

public virtual AsyncUnaryCall<ListWorkflowsResponse> ListWorkflowsAsync(ListWorkflowsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListWorkflowsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListWorkflowsResponse	The call object.

ListWorkflowsAsync(ListWorkflowsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListWorkflowsResponse> ListWorkflowsAsync(ListWorkflowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListWorkflowsRequest 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
AsyncUnaryCallListWorkflowsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Workflows.WorkflowsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
WorkflowsWorkflowsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Workflows.V1.Workflows.WorkflowsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateWorkflow(UpdateWorkflowRequest, CallOptions)

public virtual Operation UpdateWorkflow(UpdateWorkflowRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateWorkflow(UpdateWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateWorkflow(UpdateWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
Operation	The response received from the server.

UpdateWorkflowAsync(UpdateWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateWorkflowAsync(UpdateWorkflowRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateWorkflowAsync(UpdateWorkflowRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateWorkflowAsync(UpdateWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
AsyncUnaryCallOperation	The call object.