Google Cloud Dataproc v1 API - Class WorkflowTemplateServiceClientImpl (5.4.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

Inherited Members

WorkflowTemplateServiceClient.DefaultEndpoint

WorkflowTemplateServiceClient.DefaultScopes

WorkflowTemplateServiceClient.ServiceMetadata

WorkflowTemplateServiceClient.CreateAsync(CancellationToken)

WorkflowTemplateServiceClient.Create()

WorkflowTemplateServiceClient.ShutdownDefaultChannelsAsync()

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(CreateWorkflowTemplateRequest, CancellationToken)

WorkflowTemplateServiceClient.CreateWorkflowTemplate(String, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(String, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(String, WorkflowTemplate, CancellationToken)

WorkflowTemplateServiceClient.CreateWorkflowTemplate(RegionName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(RegionName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(RegionName, WorkflowTemplate, CancellationToken)

WorkflowTemplateServiceClient.CreateWorkflowTemplate(LocationName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(LocationName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(LocationName, WorkflowTemplate, CancellationToken)

WorkflowTemplateServiceClient.GetWorkflowTemplateAsync(GetWorkflowTemplateRequest, CancellationToken)

WorkflowTemplateServiceClient.GetWorkflowTemplate(String, CallSettings)

WorkflowTemplateServiceClient.GetWorkflowTemplateAsync(String, CallSettings)

WorkflowTemplateServiceClient.GetWorkflowTemplateAsync(String, CancellationToken)

WorkflowTemplateServiceClient.GetWorkflowTemplate(WorkflowTemplateName, CallSettings)

WorkflowTemplateServiceClient.GetWorkflowTemplateAsync(WorkflowTemplateName, CallSettings)

WorkflowTemplateServiceClient.GetWorkflowTemplateAsync(WorkflowTemplateName, CancellationToken)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(InstantiateWorkflowTemplateRequest, CancellationToken)

WorkflowTemplateServiceClient.PollOnceInstantiateWorkflowTemplate(String, CallSettings)

WorkflowTemplateServiceClient.PollOnceInstantiateWorkflowTemplateAsync(String, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplate(String, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(String, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(String, CancellationToken)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplate(WorkflowTemplateName, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(WorkflowTemplateName, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(WorkflowTemplateName, CancellationToken)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplate(String, IDictionary<String, String>, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(String, IDictionary<String, String>, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(String, IDictionary<String, String>, CancellationToken)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplate(WorkflowTemplateName, IDictionary<String, String>, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(WorkflowTemplateName, IDictionary<String, String>, CallSettings)

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(WorkflowTemplateName, IDictionary<String, String>, CancellationToken)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(InstantiateInlineWorkflowTemplateRequest, CancellationToken)

WorkflowTemplateServiceClient.PollOnceInstantiateInlineWorkflowTemplate(String, CallSettings)

WorkflowTemplateServiceClient.PollOnceInstantiateInlineWorkflowTemplateAsync(String, CallSettings)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplate(String, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(String, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(String, WorkflowTemplate, CancellationToken)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplate(RegionName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(RegionName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(RegionName, WorkflowTemplate, CancellationToken)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplate(LocationName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(LocationName, WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(LocationName, WorkflowTemplate, CancellationToken)

WorkflowTemplateServiceClient.UpdateWorkflowTemplateAsync(UpdateWorkflowTemplateRequest, CancellationToken)

WorkflowTemplateServiceClient.UpdateWorkflowTemplate(WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.UpdateWorkflowTemplateAsync(WorkflowTemplate, CallSettings)

WorkflowTemplateServiceClient.UpdateWorkflowTemplateAsync(WorkflowTemplate, CancellationToken)

WorkflowTemplateServiceClient.ListWorkflowTemplates(String, String, Nullable<Int32>, CallSettings)

WorkflowTemplateServiceClient.ListWorkflowTemplatesAsync(String, String, Nullable<Int32>, CallSettings)

WorkflowTemplateServiceClient.ListWorkflowTemplates(RegionName, String, Nullable<Int32>, CallSettings)

WorkflowTemplateServiceClient.ListWorkflowTemplatesAsync(RegionName, String, Nullable<Int32>, CallSettings)

WorkflowTemplateServiceClient.ListWorkflowTemplates(LocationName, String, Nullable<Int32>, CallSettings)

WorkflowTemplateServiceClient.ListWorkflowTemplatesAsync(LocationName, String, Nullable<Int32>, CallSettings)

WorkflowTemplateServiceClient.DeleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest, CancellationToken)

WorkflowTemplateServiceClient.DeleteWorkflowTemplate(String, CallSettings)

WorkflowTemplateServiceClient.DeleteWorkflowTemplateAsync(String, CallSettings)

WorkflowTemplateServiceClient.DeleteWorkflowTemplateAsync(String, CancellationToken)

WorkflowTemplateServiceClient.DeleteWorkflowTemplate(WorkflowTemplateName, CallSettings)

WorkflowTemplateServiceClient.DeleteWorkflowTemplateAsync(WorkflowTemplateName, CallSettings)

WorkflowTemplateServiceClient.DeleteWorkflowTemplateAsync(WorkflowTemplateName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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(WorkflowTemplateService.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`	`WorkflowTemplateService.WorkflowTemplateServiceClient` 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
`WorkflowTemplateService.WorkflowTemplateServiceClient`

Overrides

WorkflowTemplateServiceClient.GrpcClient

InstantiateInlineWorkflowTemplateOperationsClient

public override OperationsClient InstantiateInlineWorkflowTemplateOperationsClient { get; }

The long-running operations client for InstantiateInlineWorkflowTemplate.

Property Value
Type	Description
`OperationsClient`

Overrides

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateOperationsClient

InstantiateWorkflowTemplateOperationsClient

public override OperationsClient InstantiateWorkflowTemplateOperationsClient { get; }

The long-running operations client for InstantiateWorkflowTemplate.

Property Value
Type	Description
`OperationsClient`

Overrides

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateOperationsClient

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

WorkflowTemplateServiceClient.CreateWorkflowTemplate(CreateWorkflowTemplateRequest, CallSettings)

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
`Task<WorkflowTemplate>`	A Task containing the RPC response.

Overrides

WorkflowTemplateServiceClient.CreateWorkflowTemplateAsync(CreateWorkflowTemplateRequest, CallSettings)

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

WorkflowTemplateServiceClient.DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest, CallSettings)

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

WorkflowTemplateServiceClient.DeleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest, CallSettings)

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

WorkflowTemplateServiceClient.GetWorkflowTemplate(GetWorkflowTemplateRequest, CallSettings)

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
`Task<WorkflowTemplate>`	A Task containing the RPC response.

Overrides

WorkflowTemplateServiceClient.GetWorkflowTemplateAsync(GetWorkflowTemplateRequest, CallSettings)

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
`Operation<Empty, WorkflowMetadata>`	The RPC response.

Overrides

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest, CallSettings)

InstantiateInlineWorkflowTemplateAsync(InstantiateInlineWorkflowTemplateRequest, CallSettings)

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

Instantiates a template and begins execution.

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
`Task<Operation<Empty, WorkflowMetadata>>`	A Task containing the RPC response.

Overrides

WorkflowTemplateServiceClient.InstantiateInlineWorkflowTemplateAsync(InstantiateInlineWorkflowTemplateRequest, CallSettings)

InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest, CallSettings)

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

Instantiates a template and begins execution.

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
`Operation<Empty, WorkflowMetadata>`	The RPC response.

Overrides

WorkflowTemplateServiceClient.InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest, CallSettings)

InstantiateWorkflowTemplateAsync(InstantiateWorkflowTemplateRequest, CallSettings)

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

Instantiates a template and begins execution.

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
`Task<Operation<Empty, WorkflowMetadata>>`	A Task containing the RPC response.

Overrides

WorkflowTemplateServiceClient.InstantiateWorkflowTemplateAsync(InstantiateWorkflowTemplateRequest, CallSettings)

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
`PagedEnumerable<ListWorkflowTemplatesResponse, WorkflowTemplate>`	A pageable sequence of WorkflowTemplate resources.

Overrides

WorkflowTemplateServiceClient.ListWorkflowTemplates(ListWorkflowTemplatesRequest, CallSettings)

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
`PagedAsyncEnumerable<ListWorkflowTemplatesResponse, WorkflowTemplate>`	A pageable asynchronous sequence of WorkflowTemplate resources.

Overrides

WorkflowTemplateServiceClient.ListWorkflowTemplatesAsync(ListWorkflowTemplatesRequest, CallSettings)

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

WorkflowTemplateServiceClient.UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest, CallSettings)

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
`Task<WorkflowTemplate>`	A Task containing the RPC response.

Overrides

WorkflowTemplateServiceClient.UpdateWorkflowTemplateAsync(UpdateWorkflowTemplateRequest, CallSettings)