Class WorkflowsClientImpl

public sealed class WorkflowsClientImpl : WorkflowsClient

Workflows client wrapper implementation, for convenient use.

Inheritance

Object > WorkflowsClient > WorkflowsClientImpl

Namespace

Google.Cloud.Workflows.V1Beta

Assembly

Google.Cloud.Workflows.V1Beta.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(Workflows.WorkflowsClient, WorkflowsSettings)

public WorkflowsClientImpl(Workflows.WorkflowsClient grpcClient, WorkflowsSettings settings)

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

Parameters
TypeNameDescription
Workflows.WorkflowsClientgrpcClient

The underlying gRPC client.

WorkflowsSettingssettings

The base WorkflowsSettings used within this client.

Properties

CreateWorkflowOperationsClient

public override OperationsClient CreateWorkflowOperationsClient { get; }

The long-running operations client for CreateWorkflow.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteWorkflowOperationsClient

public override OperationsClient DeleteWorkflowOperationsClient { get; }

The long-running operations client for DeleteWorkflow.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override Workflows.WorkflowsClient GrpcClient { get; }

The underlying gRPC Workflows client

Property Value
TypeDescription
Workflows.WorkflowsClient
Overrides

UpdateWorkflowOperationsClient

public override OperationsClient UpdateWorkflowOperationsClient { get; }

The long-running operations client for UpdateWorkflow.

Property Value
TypeDescription
OperationsClient
Overrides

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 will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.

Parameters
TypeNameDescription
CreateWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Workflow, OperationMetadata>

The RPC response.

Overrides

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 will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.

Parameters
TypeNameDescription
CreateWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Workflow, OperationMetadata>>

A Task containing the RPC response.

Overrides

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
TypeNameDescription
DeleteWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

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
TypeNameDescription
DeleteWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Overrides

GetWorkflow(GetWorkflowRequest, CallSettings)

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

Gets details of a single Workflow.

Parameters
TypeNameDescription
GetWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Workflow

The RPC response.

Overrides

GetWorkflowAsync(GetWorkflowRequest, CallSettings)

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

Gets details of a single Workflow.

Parameters
TypeNameDescription
GetWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Workflow>

A Task containing the RPC response.

Overrides

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
TypeNameDescription
ListWorkflowsRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListWorkflowsResponse, Workflow>

A pageable sequence of Workflow resources.

Overrides

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
TypeNameDescription
ListWorkflowsRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListWorkflowsResponse, Workflow>

A pageable asynchronous sequence of Workflow resources.

Overrides

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 may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.

Parameters
TypeNameDescription
UpdateWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Workflow, OperationMetadata>

The RPC response.

Overrides

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 may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.

Parameters
TypeNameDescription
UpdateWorkflowRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Workflow, OperationMetadata>>

A Task containing the RPC response.

Overrides