public abstract class WorkflowTemplateServiceClient
Reference documentation and code samples for the Google Cloud Dataproc v1 API class WorkflowTemplateServiceClient.
WorkflowTemplateService client wrapper, for convenient use.
Derived Types
Namespace
GoogleCloudGoogle.Cloud.DataprocV1Assembly
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 | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default WorkflowTemplateService scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default WorkflowTemplateService scopes are:
GrpcClient
public virtual WorkflowTemplateService.WorkflowTemplateServiceClient GrpcClient { get; }
The underlying gRPC WorkflowTemplateService client
Property Value | |
---|---|
Type | Description |
WorkflowTemplateServiceWorkflowTemplateServiceClient |
IAMPolicyClient
public virtual IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
InstantiateInlineWorkflowTemplateOperationsClient
public virtual OperationsClient InstantiateInlineWorkflowTemplateOperationsClient { get; }
The long-running operations client for InstantiateInlineWorkflowTemplate
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
InstantiateWorkflowTemplateOperationsClient
public virtual OperationsClient InstantiateWorkflowTemplateOperationsClient { get; }
The long-running operations client for InstantiateWorkflowTemplate
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
WorkflowTemplate | The RPC response. |
// 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 | |
---|---|
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. |
// 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 | |
---|---|
Name | Description |
parent | RegionName Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
WorkflowTemplate | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | string Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
WorkflowTemplate | The RPC response. |
// 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 | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskWorkflowTemplate | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskWorkflowTemplate | A Task containing the RPC response. |
// 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 | |
---|---|
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. |
// 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 | |
---|---|
Name | Description |
request | CreateWorkflowTemplateRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskWorkflowTemplate | A Task containing the RPC response. |
// 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 | |
---|---|
Name | Description |
parent | RegionName Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskWorkflowTemplate | A Task containing the RPC response. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
RegionName parent = RegionName.FromProjectRegion("[PROJECT]", "[REGION]");
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(parent, template);
CreateWorkflowTemplateAsync(RegionName, WorkflowTemplate, CancellationToken)
public virtual Task<WorkflowTemplate> CreateWorkflowTemplateAsync(RegionName parent, WorkflowTemplate template, CancellationToken cancellationToken)
Creates new workflow template.
Parameters | |
---|---|
Name | Description |
parent | RegionName Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskWorkflowTemplate | A Task containing the RPC response. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
RegionName parent = RegionName.FromProjectRegion("[PROJECT]", "[REGION]");
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(parent, template);
CreateWorkflowTemplateAsync(string, WorkflowTemplate, CallSettings)
public virtual Task<WorkflowTemplate> CreateWorkflowTemplateAsync(string parent, WorkflowTemplate template, CallSettings callSettings = null)
Creates new workflow template.
Parameters | |
---|---|
Name | Description |
parent | string Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskWorkflowTemplate | A Task containing the RPC response. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/regions/[REGION]";
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(parent, template);
CreateWorkflowTemplateAsync(string, WorkflowTemplate, CancellationToken)
public virtual Task<WorkflowTemplate> CreateWorkflowTemplateAsync(string parent, WorkflowTemplate template, CancellationToken cancellationToken)
Creates new workflow template.
Parameters | |
---|---|
Name | Description |
parent | string Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
template | WorkflowTemplate Required. The Dataproc workflow template to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskWorkflowTemplate | A Task containing the RPC response. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/regions/[REGION]";
WorkflowTemplate template = new WorkflowTemplate();
// Make the request
WorkflowTemplate response = await workflowTemplateServiceClient.CreateWorkflowTemplateAsync(parent, template);
DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest, CallSettings)
public virtual 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. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.Create();
// Initialize request argument(s)
DeleteWorkflowTemplateRequest request = new DeleteWorkflowTemplateRequest
{
WorkflowTemplateName = WorkflowTemplateName.FromProjectRegionWorkflowTemplate("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]"),
Version = 0,
};
// Make the request
workflowTemplateServiceClient.DeleteWorkflowTemplate(request);
DeleteWorkflowTemplate(WorkflowTemplateName, CallSettings)
public virtual void DeleteWorkflowTemplate(WorkflowTemplateName name, CallSettings callSettings = null)
Deletes a workflow template. It does not cancel in-progress workflows.
Parameters | |
---|---|
Name | Description |
name | WorkflowTemplateName Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.Create();
// Initialize request argument(s)
WorkflowTemplateName name = WorkflowTemplateName.FromProjectRegionWorkflowTemplate("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
// Make the request
workflowTemplateServiceClient.DeleteWorkflowTemplate(name);
DeleteWorkflowTemplate(string, CallSettings)
public virtual void DeleteWorkflowTemplate(string name, CallSettings callSettings = null)
Deletes a workflow template. It does not cancel in-progress workflows.
Parameters | |
---|---|
Name | Description |
name | string Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/regions/[REGION]/workflowTemplates/[WORKFLOW_TEMPLATE]";
// Make the request
workflowTemplateServiceClient.DeleteWorkflowTemplate(name);
DeleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest, CallSettings)
public virtual 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. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteWorkflowTemplateRequest request = new DeleteWorkflowTemplateRequest
{
WorkflowTemplateName = WorkflowTemplateName.FromProjectRegionWorkflowTemplate("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]"),
Version = 0,
};
// Make the request
await workflowTemplateServiceClient.DeleteWorkflowTemplateAsync(request);
DeleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest, CancellationToken)
public virtual Task DeleteWorkflowTemplateAsync(DeleteWorkflowTemplateRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteWorkflowTemplateRequest request = new DeleteWorkflowTemplateRequest
{
WorkflowTemplateName = WorkflowTemplateName.FromProjectRegionWorkflowTemplate("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]"),
Version = 0,
};
// Make the request
await workflowTemplateServiceClient.DeleteWorkflowTemplateAsync(request);
DeleteWorkflowTemplateAsync(WorkflowTemplateName, CallSettings)
public virtual Task DeleteWorkflowTemplateAsync(WorkflowTemplateName name, CallSettings callSettings = null)
Deletes a workflow template. It does not cancel in-progress workflows.
Parameters | |
---|---|
Name | Description |
name | WorkflowTemplateName Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
WorkflowTemplateName name = WorkflowTemplateName.FromProjectRegionWorkflowTemplate("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
// Make the request
await workflowTemplateServiceClient.DeleteWorkflowTemplateAsync(name);
DeleteWorkflowTemplateAsync(WorkflowTemplateName, CancellationToken)
public virtual Task DeleteWorkflowTemplateAsync(WorkflowTemplateName name, CancellationToken cancellationToken)
Deletes a workflow template. It does not cancel in-progress workflows.
Parameters | |
---|---|
Name | Description |
name | WorkflowTemplateName Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
WorkflowTemplateServiceClient workflowTemplateServiceClient = await WorkflowTemplateServiceClient.CreateAsync();
// Initialize request argument(s)
WorkflowTemplateName name = WorkflowTemplateName.FromProjectRegionWorkflowTemplate("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
// Make the request
await workflowTemplateServiceClient.DeleteWorkflowTemplateAsync(name);
DeleteWorkflowTemplateAsync(string, CallSettings)
public virtual Task DeleteWorkflowTemplateAsync(string name, CallSettings callSettings = null)
Deletes a workflow template. It does not cancel in-progress workflows.
Parameters | |
---|---|
Name | Description |
name | string Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description< |