Google Cloud Dataproc v1 API - Class WorkflowTemplateServiceClient (5.9.0)

public abstract class WorkflowTemplateServiceClient

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

WorkflowTemplateService client wrapper, for convenient use.

Inheritance

object > WorkflowTemplateServiceClient

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Remarks

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

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the WorkflowTemplateService service, which is a host of "dataproc.googleapis.com" and a port of 443.

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default WorkflowTemplateService scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

The default WorkflowTemplateService scopes are:

GrpcClient

public virtual WorkflowTemplateService.WorkflowTemplateServiceClient GrpcClient { get; }

The underlying gRPC WorkflowTemplateService client

Property Value
TypeDescription
WorkflowTemplateServiceWorkflowTemplateServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient

InstantiateInlineWorkflowTemplateOperationsClient

public virtual OperationsClient InstantiateInlineWorkflowTemplateOperationsClient { get; }

The long-running operations client for InstantiateInlineWorkflowTemplate.

Property Value
TypeDescription
OperationsClient

InstantiateWorkflowTemplateOperationsClient

public virtual OperationsClient InstantiateWorkflowTemplateOperationsClient { get; }

The long-running operations client for InstantiateWorkflowTemplate.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

Create()

public static WorkflowTemplateServiceClient Create()

Synchronously creates a WorkflowTemplateServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use WorkflowTemplateServiceClientBuilder.

Returns
TypeDescription
WorkflowTemplateServiceClient

The created WorkflowTemplateServiceClient.

CreateAsync(CancellationToken)

public static Task<WorkflowTemplateServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a WorkflowTemplateServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use WorkflowTemplateServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskWorkflowTemplateServiceClient

The task representing the created WorkflowTemplateServiceClient.

CreateWorkflowTemplate(LocationName, WorkflowTemplate, CallSettings)

public virtual WorkflowTemplate CreateWorkflowTemplate(LocationName parent, WorkflowTemplate template, CallSettings callSettings = null)

Creates new workflow template.

Parameters
NameDescription
parentLocationName

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

templateWorkflowTemplate

Required. The Dataproc workflow template to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WorkflowTemplate

The RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = workflowTemplateServiceClient.CreateWorkflowTemplate(parent, template);

CreateWorkflowTemplate(CreateWorkflowTemplateRequest, CallSettings)

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

Creates new workflow template.

Parameters
NameDescription
requestCreateWorkflowTemplateRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WorkflowTemplate

The RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.Create();
// Initialize request argument(s)
CreateWorkflowTemplateRequest request = new CreateWorkflowTemplateRequest
{
    ParentAsRegionName = RegionName.FromProjectRegion("[PROJECT]", "[REGION]"),
    Template = new WorkflowTemplate(),
};
// Make the request
WorkflowTemplate response = workflowTemplateServiceClient.CreateWorkflowTemplate(request);

CreateWorkflowTemplate(RegionName, WorkflowTemplate, CallSettings)

public virtual WorkflowTemplate CreateWorkflowTemplate(RegionName parent, WorkflowTemplate template, CallSettings callSettings = null)

Creates new workflow template.

Parameters
NameDescription
parentRegionName

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

templateWorkflowTemplate

Required. The Dataproc workflow template to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WorkflowTemplate

The RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.Create();
// Initialize request argument(s)
RegionName parent = RegionName.FromProjectRegion("[PROJECT]", "[REGION]");
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = workflowTemplateServiceClient.CreateWorkflowTemplate(parent, template);

CreateWorkflowTemplate(string, WorkflowTemplate, CallSettings)

public virtual WorkflowTemplate CreateWorkflowTemplate(string parent, WorkflowTemplate template, CallSettings callSettings = null)

Creates new workflow template.

Parameters
NameDescription
parentstring

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

templateWorkflowTemplate

Required. The Dataproc workflow template to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WorkflowTemplate

The RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/regions/[REGION]";
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = workflowTemplateServiceClient.CreateWorkflowTemplate(parent, template);

CreateWorkflowTemplateAsync(LocationName, WorkflowTemplate, CallSettings)

public virtual Task<WorkflowTemplate> CreateWorkflowTemplateAsync(LocationName parent, WorkflowTemplate template, CallSettings callSettings = null)

Creates new workflow template.

Parameters
NameDescription
parentLocationName

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

templateWorkflowTemplate

Required. The Dataproc workflow template to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWorkflowTemplate

A Task containing the RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(parent, template);

CreateWorkflowTemplateAsync(LocationName, WorkflowTemplate, CancellationToken)

public virtual Task<WorkflowTemplate> CreateWorkflowTemplateAsync(LocationName parent, WorkflowTemplate template, CancellationToken cancellationToken)

Creates new workflow template.

Parameters
NameDescription
parentLocationName

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region}

  • For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

templateWorkflowTemplate

Required. The Dataproc workflow template to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWorkflowTemplate

A Task containing the RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(parent, template);

CreateWorkflowTemplateAsync(CreateWorkflowTemplateRequest, CallSettings)

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

Creates new workflow template.

Parameters
NameDescription
requestCreateWorkflowTemplateRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWorkflowTemplate

A Task containing the RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
CreateWorkflowTemplateRequest request = new CreateWorkflowTemplateRequest
{
    ParentAsRegionName = RegionName.FromProjectRegion("[PROJECT]", "[REGION]"),
    Template = new WorkflowTemplate(),
};
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(request);

CreateWorkflowTemplateAsync(CreateWorkflowTemplateRequest, CancellationToken)

public virtual Task<WorkflowTemplate> CreateWorkflowTemplateAsync(CreateWorkflowTemplateRequest request, CancellationToken cancellationToken)

Creates new workflow template.

Parameters
NameDescription
requestCreateWorkflowTemplateRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWorkflowTemplate

A Task containing the RPC response.

Example
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
CreateWorkflowTemplateRequest request = new CreateWorkflowTemplateRequest
{
    ParentAsRegionName = RegionName.FromProjectRegion("[PROJECT]", "[REGION]"),
    Template = new WorkflowTemplate(),
};
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(request);

CreateWorkflowTemplateAsync(RegionName, WorkflowTemplate, CallSettings)

public virtual Task<WorkflowTemplate> CreateWorkflowTemplateAsync(RegionName parent, WorkflowTemplate template, CallSettings callSettings = null)

Creates new workflow template.

Parameters
NameDescription
parent