Workflows v1 API - Class WorkflowsClientImpl (2.3.0)

Version 2.3.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 sealed class WorkflowsClientImpl : WorkflowsClient

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

Workflows client wrapper implementation, for convenient use.

Inheritance

object > WorkflowsClient > WorkflowsClientImpl

Inherited Members

WorkflowsClient.DefaultEndpoint

WorkflowsClient.DefaultScopes

WorkflowsClient.ServiceMetadata

WorkflowsClient.CreateAsync(CancellationToken)

WorkflowsClient.Create()

WorkflowsClient.ShutdownDefaultChannelsAsync()

WorkflowsClient.ListWorkflows(string, string, int?, CallSettings)

WorkflowsClient.ListWorkflowsAsync(string, string, int?, CallSettings)

WorkflowsClient.ListWorkflows(LocationName, string, int?, CallSettings)

WorkflowsClient.ListWorkflowsAsync(LocationName, string, int?, CallSettings)

WorkflowsClient.GetWorkflowAsync(GetWorkflowRequest, CancellationToken)

WorkflowsClient.GetWorkflow(string, CallSettings)

WorkflowsClient.GetWorkflowAsync(string, CallSettings)

WorkflowsClient.GetWorkflowAsync(string, CancellationToken)

WorkflowsClient.GetWorkflow(WorkflowName, CallSettings)

WorkflowsClient.GetWorkflowAsync(WorkflowName, CallSettings)

WorkflowsClient.GetWorkflowAsync(WorkflowName, CancellationToken)

WorkflowsClient.CreateWorkflowAsync(CreateWorkflowRequest, CancellationToken)

WorkflowsClient.PollOnceCreateWorkflow(string, CallSettings)

WorkflowsClient.PollOnceCreateWorkflowAsync(string, CallSettings)

WorkflowsClient.CreateWorkflow(string, Workflow, string, CallSettings)

WorkflowsClient.CreateWorkflowAsync(string, Workflow, string, CallSettings)

WorkflowsClient.CreateWorkflowAsync(string, Workflow, string, CancellationToken)

WorkflowsClient.CreateWorkflow(LocationName, Workflow, string, CallSettings)

WorkflowsClient.CreateWorkflowAsync(LocationName, Workflow, string, CallSettings)

WorkflowsClient.CreateWorkflowAsync(LocationName, Workflow, string, CancellationToken)

WorkflowsClient.DeleteWorkflowAsync(DeleteWorkflowRequest, CancellationToken)

WorkflowsClient.PollOnceDeleteWorkflow(string, CallSettings)

WorkflowsClient.PollOnceDeleteWorkflowAsync(string, CallSettings)

WorkflowsClient.DeleteWorkflow(string, CallSettings)

WorkflowsClient.DeleteWorkflowAsync(string, CallSettings)

WorkflowsClient.DeleteWorkflowAsync(string, CancellationToken)

WorkflowsClient.DeleteWorkflow(WorkflowName, CallSettings)

WorkflowsClient.DeleteWorkflowAsync(WorkflowName, CallSettings)

WorkflowsClient.DeleteWorkflowAsync(WorkflowName, CancellationToken)

WorkflowsClient.UpdateWorkflowAsync(UpdateWorkflowRequest, CancellationToken)

WorkflowsClient.PollOnceUpdateWorkflow(string, CallSettings)

WorkflowsClient.PollOnceUpdateWorkflowAsync(string, CallSettings)

WorkflowsClient.UpdateWorkflow(Workflow, FieldMask, CallSettings)

WorkflowsClient.UpdateWorkflowAsync(Workflow, FieldMask, CallSettings)

WorkflowsClient.UpdateWorkflowAsync(Workflow, FieldMask, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Workflows.V1

Assembly

Google.Cloud.Workflows.V1.dll

Remarks

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

Constructors

WorkflowsClientImpl(WorkflowsClient, WorkflowsSettings, ILogger)

public WorkflowsClientImpl(Workflows.WorkflowsClient grpcClient, WorkflowsSettings settings, ILogger logger)

Constructs a client wrapper for the Workflows service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	WorkflowsWorkflowsClient The underlying gRPC client.
settings	WorkflowsSettings The base WorkflowsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateWorkflowOperationsClient

public override OperationsClient CreateWorkflowOperationsClient { get; }

The long-running operations client for CreateWorkflow.

Property Value
Type	Description
OperationsClient

Overrides

WorkflowsClient.CreateWorkflowOperationsClient

DeleteWorkflowOperationsClient

public override OperationsClient DeleteWorkflowOperationsClient { get; }

The long-running operations client for DeleteWorkflow.

Property Value
Type	Description
OperationsClient

Overrides

WorkflowsClient.DeleteWorkflowOperationsClient

GrpcClient

public override Workflows.WorkflowsClient GrpcClient { get; }

The underlying gRPC Workflows client

Property Value
Type	Description
WorkflowsWorkflowsClient

Overrides

WorkflowsClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

WorkflowsClient.LocationsClient

UpdateWorkflowOperationsClient

public override OperationsClient UpdateWorkflowOperationsClient { get; }

The long-running operations client for UpdateWorkflow.

Property Value
Type	Description
OperationsClient

Overrides

WorkflowsClient.UpdateWorkflowOperationsClient

Methods

CreateWorkflow(CreateWorkflowRequest, CallSettings)

public override Operation<Workflow, OperationMetadata> CreateWorkflow(CreateWorkflowRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	CreateWorkflowRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationWorkflowOperationMetadata	The RPC response.

Overrides

WorkflowsClient.CreateWorkflow(CreateWorkflowRequest, CallSettings)

CreateWorkflowAsync(CreateWorkflowRequest, CallSettings)

public override Task<Operation<Workflow, OperationMetadata>> CreateWorkflowAsync(CreateWorkflowRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	CreateWorkflowRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationWorkflowOperationMetadata	A Task containing the RPC response.

Overrides

WorkflowsClient.CreateWorkflowAsync(CreateWorkflowRequest, CallSettings)

DeleteWorkflow(DeleteWorkflowRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteWorkflow(DeleteWorkflowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Overrides

WorkflowsClient.DeleteWorkflow(DeleteWorkflowRequest, CallSettings)

DeleteWorkflowAsync(DeleteWorkflowRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteWorkflowAsync(DeleteWorkflowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Overrides

WorkflowsClient.DeleteWorkflowAsync(DeleteWorkflowRequest, CallSettings)

GetWorkflow(GetWorkflowRequest, CallSettings)

public override Workflow GetWorkflow(GetWorkflowRequest request, CallSettings callSettings = null)

Gets details of a single workflow.

Parameters
Name	Description
request	GetWorkflowRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Workflow	The RPC response.

Overrides

WorkflowsClient.GetWorkflow(GetWorkflowRequest, CallSettings)

GetWorkflowAsync(GetWorkflowRequest, CallSettings)

public override Task<Workflow> GetWorkflowAsync(GetWorkflowRequest request, CallSettings callSettings = null)

Gets details of a single workflow.

Parameters
Name	Description
request	GetWorkflowRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskWorkflow	A Task containing the RPC response.

Overrides

WorkflowsClient.GetWorkflowAsync(GetWorkflowRequest, CallSettings)

ListWorkflows(ListWorkflowsRequest, CallSettings)

public override PagedEnumerable<ListWorkflowsResponse, Workflow> ListWorkflows(ListWorkflowsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListWorkflowsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListWorkflowsResponseWorkflow	A pageable sequence of Workflow resources.

Overrides

WorkflowsClient.ListWorkflows(ListWorkflowsRequest, CallSettings)

ListWorkflowsAsync(ListWorkflowsRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkflowsResponse, Workflow> ListWorkflowsAsync(ListWorkflowsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListWorkflowsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListWorkflowsResponseWorkflow	A pageable asynchronous sequence of Workflow resources.

Overrides

WorkflowsClient.ListWorkflowsAsync(ListWorkflowsRequest, CallSettings)

UpdateWorkflow(UpdateWorkflowRequest, CallSettings)

public override Operation<Workflow, OperationMetadata> UpdateWorkflow(UpdateWorkflowRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateWorkflowRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationWorkflowOperationMetadata	The RPC response.

Overrides

WorkflowsClient.UpdateWorkflow(UpdateWorkflowRequest, CallSettings)

UpdateWorkflowAsync(UpdateWorkflowRequest, CallSettings)

public override Task<Operation<Workflow, OperationMetadata>> UpdateWorkflowAsync(UpdateWorkflowRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateWorkflowRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationWorkflowOperationMetadata	A Task containing the RPC response.

Overrides

WorkflowsClient.UpdateWorkflowAsync(UpdateWorkflowRequest, CallSettings)