public sealed class WorkflowsClientImpl : WorkflowsClientReference documentation and code samples for the Workflows v1 API class WorkflowsClientImpl.
Workflows client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Workflows.V1Assembly
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 | WorkflowsWorkflowsClientThe underlying gRPC client. |
settings | WorkflowsSettingsThe base WorkflowsSettings used within this client. |
logger | ILoggerOptional 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 | |
DeleteWorkflowOperationsClient
public override OperationsClient DeleteWorkflowOperationsClient { get; }The long-running operations client for DeleteWorkflow.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override Workflows.WorkflowsClient GrpcClient { get; }The underlying gRPC Workflows client
| Property Value | |
|---|---|
| Type | Description |
WorkflowsWorkflowsClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
UpdateWorkflowOperationsClient
public override OperationsClient UpdateWorkflowOperationsClient { get; }The long-running operations client for UpdateWorkflow.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | CreateWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationWorkflowOperationMetadata | The RPC response. |
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 | CreateWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationWorkflowOperationMetadata | A Task containing the RPC response. |
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 | DeleteWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
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 | DeleteWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
GetWorkflow(GetWorkflowRequest, CallSettings)
public override Workflow GetWorkflow(GetWorkflowRequest request, CallSettings callSettings = null)Gets details of a single workflow.
| Parameters | |
|---|---|
| Name | Description |
request | GetWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Workflow | The RPC response. |
GetWorkflowAsync(GetWorkflowRequest, CallSettings)
public override Task<Workflow> GetWorkflowAsync(GetWorkflowRequest request, CallSettings callSettings = null)Gets details of a single workflow.
| Parameters | |
|---|---|
| Name | Description |
request | GetWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskWorkflow | A Task containing the RPC response. |
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 | ListWorkflowsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListWorkflowsResponseWorkflow | A pageable sequence of Workflow resources. |
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 | ListWorkflowsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListWorkflowsResponseWorkflow | A pageable asynchronous sequence of Workflow resources. |
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 | UpdateWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationWorkflowOperationMetadata | The RPC response. |
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 | UpdateWorkflowRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationWorkflowOperationMetadata | A Task containing the RPC response. |