Google Cloud Dataproc v1 API - Class WorkflowTemplateServiceClientImpl (5.12.0) 

public sealed class WorkflowTemplateServiceClientImpl : WorkflowTemplateServiceClient

Reference documentation and code samples for the Google Cloud Dataproc v1 API class WorkflowTemplateServiceClientImpl.

WorkflowTemplateService client wrapper implementation, for convenient use.

Inheritance

object > WorkflowTemplateServiceClient > WorkflowTemplateServiceClientImpl

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Remarks

The API interface for managing Workflow Templates in the Dataproc API.

Constructors

WorkflowTemplateServiceClientImpl(WorkflowTemplateServiceClient, WorkflowTemplateServiceSettings, ILogger)

public WorkflowTemplateServiceClientImpl(WorkflowTemplateService.WorkflowTemplateServiceClient grpcClient, WorkflowTemplateServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient WorkflowTemplateServiceWorkflowTemplateServiceClient

The underlying gRPC client.
settings WorkflowTemplateServiceSettings

The base WorkflowTemplateServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override WorkflowTemplateService.WorkflowTemplateServiceClient GrpcClient { get; }

The underlying gRPC WorkflowTemplateService client

Property Value
Type Description
WorkflowTemplateServiceWorkflowTemplateServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

InstantiateInlineWorkflowTemplateOperationsClient

public override OperationsClient InstantiateInlineWorkflowTemplateOperationsClient { get; }

The long-running operations client for InstantiateInlineWorkflowTemplate.

Property Value
Type Description
OperationsClient
Overrides

InstantiateWorkflowTemplateOperationsClient

public override OperationsClient InstantiateWorkflowTemplateOperationsClient { get; }

The long-running operations client for InstantiateWorkflowTemplate.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateWorkflowTemplate(CreateWorkflowTemplateRequest, CallSettings)

public override WorkflowTemplate CreateWorkflowTemplate(CreateWorkflowTemplateRequest request, CallSettings callSettings = null)

Creates new workflow template.

Parameters
Name Description
request CreateWorkflowTemplateRequest

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
WorkflowTemplate

The RPC response.
Overrides

CreateWorkflowTemplateAsync(CreateWorkflowTemplateRequest, CallSettings)

public override Task<WorkflowTemplate> CreateWorkflowTemplateAsync(CreateWorkflowTemplateRequest request, CallSettings callSettings = null)

Creates new workflow template.

Parameters
Name Description
request CreateWorkflowTemplateRequest

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
TaskWorkflowTemplate

A Task containing the RPC response.
Overrides

DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest, CallSettings)

public override void DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest request, CallSettings callSettings = null)

Deletes a workflow template. It does not cancel in-progress workflows.

Parameters
Name Description
request DeleteWorkflowTemplateRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest, CallSettings)

public override Task DeleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest request, CallSettings callSettings = null)

Deletes a workflow template. It does not cancel in-progress workflows.

Parameters
Name Description
request DeleteWorkflowTemplateRequest

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
Task

A Task containing the RPC response.
Overrides

GetWorkflowTemplate(GetWorkflowTemplateRequest, CallSettings)

public override WorkflowTemplate GetWorkflowTemplate(GetWorkflowTemplateRequest request, CallSettings callSettings = null)

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Parameters
Name Description
request GetWorkflowTemplateRequest

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
WorkflowTemplate

The RPC response.
Overrides

GetWorkflowTemplateAsync(GetWorkflowTemplateRequest, CallSettings)

public override Task<WorkflowTemplate> GetWorkflowTemplateAsync(GetWorkflowTemplateRequest request, CallSettings callSettings = null)

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Parameters
Name Description
request GetWorkflowTemplateRequest

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
TaskWorkflowTemplate

A Task containing the RPC response.
Overrides

InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest, CallSettings)

public override Operation<Empty, WorkflowMetadata> InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request, CallSettings callSettings = null)

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate].

The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The [Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].

Parameters
Name Description
request InstantiateInlineWorkflowTemplateRequest

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
OperationEmptyWorkflowMetadata

The RPC response.
Overrides

InstantiateInlineWorkflowTemplateAsync(InstantiateInlineWorkflowTemplateRequest, CallSettings)

public override Task<Operation<Empty, WorkflowMetadata>> InstantiateInlineWorkflowTemplateAsync(InstantiateInlineWorkflowTemplateRequest request, CallSettings callSettings = null)

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate].

The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The [Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].

Parameters
Name Description
request InstantiateInlineWorkflowTemplateRequest

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
TaskOperationEmptyWorkflowMetadata

A Task containing the RPC response.
Overrides

InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest, CallSettings)

public override Operation<Empty, WorkflowMetadata> InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request, CallSettings callSettings = null)

Instantiates a template and begins execution.

The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The [Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].

Parameters
Name Description
request InstantiateWorkflowTemplateRequest

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
OperationEmptyWorkflowMetadata

The RPC response.
Overrides

InstantiateWorkflowTemplateAsync(InstantiateWorkflowTemplateRequest, CallSettings)

public override Task<Operation<Empty, WorkflowMetadata>> InstantiateWorkflowTemplateAsync(InstantiateWorkflowTemplateRequest request, CallSettings callSettings = null)

Instantiates a template and begins execution.

The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The [Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].

Parameters
Name Description
request InstantiateWorkflowTemplateRequest

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
TaskOperationEmptyWorkflowMetadata

A Task containing the RPC response.
Overrides

ListWorkflowTemplates(ListWorkflowTemplatesRequest, CallSettings)

public override PagedEnumerable<ListWorkflowTemplatesResponse, WorkflowTemplate> ListWorkflowTemplates(ListWorkflowTemplatesRequest request, CallSettings callSettings = null)

Lists workflows that match the specified filter in the request.

Parameters
Name Description
request ListWorkflowTemplatesRequest

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
PagedEnumerableListWorkflowTemplatesResponseWorkflowTemplate

A pageable sequence of WorkflowTemplate resources.
Overrides

ListWorkflowTemplatesAsync(ListWorkflowTemplatesRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkflowTemplatesResponse, WorkflowTemplate> ListWorkflowTemplatesAsync(ListWorkflowTemplatesRequest request, CallSettings callSettings = null)

Lists workflows that match the specified filter in the request.

Parameters
Name Description
request ListWorkflowTemplatesRequest

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
PagedAsyncEnumerableListWorkflowTemplatesResponseWorkflowTemplate

A pageable asynchronous sequence of WorkflowTemplate resources.
Overrides

UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest, CallSettings)

public override WorkflowTemplate UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest request, CallSettings callSettings = null)

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters
Name Description
request UpdateWorkflowTemplateRequest

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
WorkflowTemplate

The RPC response.
Overrides

UpdateWorkflowTemplateAsync(UpdateWorkflowTemplateRequest, CallSettings)

public override Task<WorkflowTemplate> UpdateWorkflowTemplateAsync(UpdateWorkflowTemplateRequest request, CallSettings callSettings = null)

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters
Name Description
request UpdateWorkflowTemplateRequest

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
TaskWorkflowTemplate

A Task containing the RPC response.
Overrides