com.google.cloud.dataproc.v1beta2

Class WorkflowTemplateServiceClient

java.lang.Object

com.google.cloud.dataproc.v1beta2.WorkflowTemplateServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class WorkflowTemplateServiceClient
extends Object
implements BackgroundResource

Service Description: The API interface for managing Workflow Templates in the Cloud Dataproc API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   WorkflowTemplate response = workflowTemplateServiceClient.createWorkflowTemplate(parent, template);
 }
 
 

Note: close() needs to be called on the workflowTemplateServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of WorkflowTemplateServiceSettings to create(). For example:

To customize credentials:

 
 WorkflowTemplateServiceSettings workflowTemplateServiceSettings =
     WorkflowTemplateServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create(workflowTemplateServiceSettings);
 
 

To customize the endpoint:

 
 WorkflowTemplateServiceSettings workflowTemplateServiceSettings =
     WorkflowTemplateServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create(workflowTemplateServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowTemplateServiceClient.ListWorkflowTemplatesFixedSizeCollection
static class	WorkflowTemplateServiceClient.ListWorkflowTemplatesPage
static class	WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkflowTemplateServiceClient(WorkflowTemplateServiceSettings settings) Constructs an instance of WorkflowTemplateServiceClient, using the given settings.
protected	WorkflowTemplateServiceClient(WorkflowTemplateServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static WorkflowTemplateServiceClient	create() Constructs an instance of WorkflowTemplateServiceClient with default settings.
static WorkflowTemplateServiceClient	create(WorkflowTemplateServiceSettings settings) Constructs an instance of WorkflowTemplateServiceClient, using the given settings.
static WorkflowTemplateServiceClient	create(WorkflowTemplateServiceStub stub) Constructs an instance of WorkflowTemplateServiceClient, using the given stub for making calls.
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	createWorkflowTemplate(com.google.cloud.dataproc.v1beta2.CreateWorkflowTemplateRequest request) Creates new workflow template.
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	createWorkflowTemplate(com.google.cloud.dataproc.v1beta2.RegionName parent, com.google.cloud.dataproc.v1beta2.WorkflowTemplate template) Creates new workflow template.
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	createWorkflowTemplate(String parent, com.google.cloud.dataproc.v1beta2.WorkflowTemplate template) Creates new workflow template.
UnaryCallable<com.google.cloud.dataproc.v1beta2.CreateWorkflowTemplateRequest,com.google.cloud.dataproc.v1beta2.WorkflowTemplate>	createWorkflowTemplateCallable() Creates new workflow template.
void	deleteWorkflowTemplate(com.google.cloud.dataproc.v1beta2.DeleteWorkflowTemplateRequest request) Deletes a workflow template.
void	deleteWorkflowTemplate(String name) Deletes a workflow template.
void	deleteWorkflowTemplate(com.google.cloud.dataproc.v1beta2.WorkflowTemplateName name) Deletes a workflow template.
UnaryCallable<com.google.cloud.dataproc.v1beta2.DeleteWorkflowTemplateRequest,Empty>	deleteWorkflowTemplateCallable() Deletes a workflow template.
OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
WorkflowTemplateServiceSettings	getSettings()
WorkflowTemplateServiceStub	getStub()
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	getWorkflowTemplate(com.google.cloud.dataproc.v1beta2.GetWorkflowTemplateRequest request) Retrieves the latest workflow template.
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	getWorkflowTemplate(String name) Retrieves the latest workflow template.
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	getWorkflowTemplate(com.google.cloud.dataproc.v1beta2.WorkflowTemplateName name) Retrieves the latest workflow template.
UnaryCallable<com.google.cloud.dataproc.v1beta2.GetWorkflowTemplateRequest,com.google.cloud.dataproc.v1beta2.WorkflowTemplate>	getWorkflowTemplateCallable() Retrieves the latest workflow template.
OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateInlineWorkflowTemplateAsync(com.google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest request) Instantiates a template and begins execution.
OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateInlineWorkflowTemplateAsync(String parent, com.google.cloud.dataproc.v1beta2.WorkflowTemplate template) Instantiates a template and begins execution.
UnaryCallable<com.google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest,Operation>	instantiateInlineWorkflowTemplateCallable() Instantiates a template and begins execution.
OperationCallable<com.google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest,Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateInlineWorkflowTemplateOperationCallable() Instantiates a template and begins execution.
OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateWorkflowTemplateAsync(com.google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest request) Instantiates a template and begins execution.
OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateWorkflowTemplateAsync(Map<String,String> parameters) Instantiates a template and begins execution.
OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateWorkflowTemplateAsync(String name) Instantiates a template and begins execution.
OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateWorkflowTemplateAsync(com.google.cloud.dataproc.v1beta2.WorkflowTemplateName name) Instantiates a template and begins execution.
UnaryCallable<com.google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest,Operation>	instantiateWorkflowTemplateCallable() Instantiates a template and begins execution.
OperationCallable<com.google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest,Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata>	instantiateWorkflowTemplateOperationCallable() Instantiates a template and begins execution.
boolean	isShutdown()
boolean	isTerminated()
WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse	listWorkflowTemplates(com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest request) Lists workflows that match the specified filter in the request.
WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse	listWorkflowTemplates(com.google.cloud.dataproc.v1beta2.RegionName parent) Lists workflows that match the specified filter in the request.
WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse	listWorkflowTemplates(String parent) Lists workflows that match the specified filter in the request.
UnaryCallable<com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest,com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesResponse>	listWorkflowTemplatesCallable() Lists workflows that match the specified filter in the request.
UnaryCallable<com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest,WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse>	listWorkflowTemplatesPagedCallable() Lists workflows that match the specified filter in the request.
void	shutdown()
void	shutdownNow()
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	updateWorkflowTemplate(com.google.cloud.dataproc.v1beta2.UpdateWorkflowTemplateRequest request) Updates (replaces) workflow template.
com.google.cloud.dataproc.v1beta2.WorkflowTemplate	updateWorkflowTemplate(com.google.cloud.dataproc.v1beta2.WorkflowTemplate template) Updates (replaces) workflow template.
UnaryCallable<com.google.cloud.dataproc.v1beta2.UpdateWorkflowTemplateRequest,com.google.cloud.dataproc.v1beta2.WorkflowTemplate>	updateWorkflowTemplateCallable() Updates (replaces) workflow template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowTemplateServiceClient

protected WorkflowTemplateServiceClient(WorkflowTemplateServiceSettings settings)
                                 throws IOException

Constructs an instance of WorkflowTemplateServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

WorkflowTemplateServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected WorkflowTemplateServiceClient(WorkflowTemplateServiceStub stub)

Method Detail

create

public static final WorkflowTemplateServiceClient create()
                                                  throws IOException

Constructs an instance of WorkflowTemplateServiceClient with default settings.

Throws:

IOException

create

public static final WorkflowTemplateServiceClient create(WorkflowTemplateServiceSettings settings)
                                                  throws IOException

Constructs an instance of WorkflowTemplateServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final WorkflowTemplateServiceClient create(WorkflowTemplateServiceStub stub)

Constructs an instance of WorkflowTemplateServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use WorkflowTemplateServiceSettings}.

getSettings

public final WorkflowTemplateServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public WorkflowTemplateServiceStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate createWorkflowTemplate(com.google.cloud.dataproc.v1beta2.RegionName parent,
                                                                                       com.google.cloud.dataproc.v1beta2.WorkflowTemplate template)

Creates new workflow template.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   WorkflowTemplate response = workflowTemplateServiceClient.createWorkflowTemplate(parent, template);
 }
 

Parameters:

parent - Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}`

template - Required. The Dataproc workflow template to create.

Throws:

ApiException - if the remote call fails

createWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate createWorkflowTemplate(String parent,
                                                                                       com.google.cloud.dataproc.v1beta2.WorkflowTemplate template)

Creates new workflow template.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   WorkflowTemplate response = workflowTemplateServiceClient.createWorkflowTemplate(parent.toString(), template);
 }
 

Parameters:

parent - Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}`

template - Required. The Dataproc workflow template to create.

Throws:

ApiException - if the remote call fails

createWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate createWorkflowTemplate(com.google.cloud.dataproc.v1beta2.CreateWorkflowTemplateRequest request)

Creates new workflow template.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   CreateWorkflowTemplateRequest request = CreateWorkflowTemplateRequest.newBuilder()
     .setParent(parent.toString())
     .setTemplate(template)
     .build();
   WorkflowTemplate response = workflowTemplateServiceClient.createWorkflowTemplate(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

createWorkflowTemplateCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.CreateWorkflowTemplateRequest,com.google.cloud.dataproc.v1beta2.WorkflowTemplate> createWorkflowTemplateCallable()

Creates new workflow template.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   CreateWorkflowTemplateRequest request = CreateWorkflowTemplateRequest.newBuilder()
     .setParent(parent.toString())
     .setTemplate(template)
     .build();
   ApiFuture<WorkflowTemplate> future = workflowTemplateServiceClient.createWorkflowTemplateCallable().futureCall(request);
   // Do something
   WorkflowTemplate response = future.get();
 }
 

getWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate getWorkflowTemplate(com.google.cloud.dataproc.v1beta2.WorkflowTemplateName name)

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   WorkflowTemplate response = workflowTemplateServiceClient.getWorkflowTemplate(name);
 }
 

Parameters:

name - Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

Throws:

ApiException - if the remote call fails

getWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate getWorkflowTemplate(String name)

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   WorkflowTemplate response = workflowTemplateServiceClient.getWorkflowTemplate(name.toString());
 }
 

Parameters:

name - Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

Throws:

ApiException - if the remote call fails

getWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate getWorkflowTemplate(com.google.cloud.dataproc.v1beta2.GetWorkflowTemplateRequest request)

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   GetWorkflowTemplateRequest request = GetWorkflowTemplateRequest.newBuilder()
     .setName(name.toString())
     .build();
   WorkflowTemplate response = workflowTemplateServiceClient.getWorkflowTemplate(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

getWorkflowTemplateCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.GetWorkflowTemplateRequest,com.google.cloud.dataproc.v1beta2.WorkflowTemplate> getWorkflowTemplateCallable()

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   GetWorkflowTemplateRequest request = GetWorkflowTemplateRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<WorkflowTemplate> future = workflowTemplateServiceClient.getWorkflowTemplateCallable().futureCall(request);
   // Do something
   WorkflowTemplate response = future.get();
 }
 

instantiateWorkflowTemplateAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateWorkflowTemplateAsync(com.google.cloud.dataproc.v1beta2.WorkflowTemplateName name)

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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   workflowTemplateServiceClient.instantiateWorkflowTemplateAsync(name).get();
 }
 

Parameters:

name - Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

Throws:

ApiException - if the remote call fails

instantiateWorkflowTemplateAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateWorkflowTemplateAsync(String name)

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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   workflowTemplateServiceClient.instantiateWorkflowTemplateAsync(name.toString()).get();
 }
 

Parameters:

name - Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

Throws:

ApiException - if the remote call fails

instantiateWorkflowTemplateAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateWorkflowTemplateAsync(Map<String,String> parameters)

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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   Map<String, String> parameters = new HashMap<>();
   workflowTemplateServiceClient.instantiateWorkflowTemplateAsync(parameters).get();
 }
 

Parameters:

parameters - Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters.

Throws:

ApiException - if the remote call fails

instantiateWorkflowTemplateAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateWorkflowTemplateAsync(com.google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest request)

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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   InstantiateWorkflowTemplateRequest request = InstantiateWorkflowTemplateRequest.newBuilder()
     .setName(name.toString())
     .build();
   workflowTemplateServiceClient.instantiateWorkflowTemplateAsync(request).get();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

instantiateWorkflowTemplateOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest,Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateWorkflowTemplateOperationCallable()

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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   InstantiateWorkflowTemplateRequest request = InstantiateWorkflowTemplateRequest.newBuilder()
     .setName(name.toString())
     .build();
   OperationFuture<Empty, WorkflowMetadata> future = workflowTemplateServiceClient.instantiateWorkflowTemplateOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

instantiateWorkflowTemplateCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.InstantiateWorkflowTemplateRequest,Operation> instantiateWorkflowTemplateCallable()

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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   InstantiateWorkflowTemplateRequest request = InstantiateWorkflowTemplateRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = workflowTemplateServiceClient.instantiateWorkflowTemplateCallable().futureCall(request);
   // Do something
   future.get();
 }
 

instantiateInlineWorkflowTemplateAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateInlineWorkflowTemplateAsync(String parent,
                                                                                                                                                                                                                                        com.google.cloud.dataproc.v1beta2.WorkflowTemplate template)

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1beta2.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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   String formattedParent = RegionName.format("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   workflowTemplateServiceClient.instantiateInlineWorkflowTemplateAsync(formattedParent, template).get();
 }
 

Parameters:

parent - Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}`

template - Required. The workflow template to instantiate.

Throws:

ApiException - if the remote call fails

instantiateInlineWorkflowTemplateAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateInlineWorkflowTemplateAsync(com.google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest request)

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1beta2.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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   String formattedParent = RegionName.format("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   InstantiateInlineWorkflowTemplateRequest request = InstantiateInlineWorkflowTemplateRequest.newBuilder()
     .setParent(formattedParent)
     .setTemplate(template)
     .build();
   workflowTemplateServiceClient.instantiateInlineWorkflowTemplateAsync(request).get();
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

instantiateInlineWorkflowTemplateOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest,Empty,com.google.cloud.dataproc.v1beta2.WorkflowMetadata> instantiateInlineWorkflowTemplateOperationCallable()

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1beta2.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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   String formattedParent = RegionName.format("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   InstantiateInlineWorkflowTemplateRequest request = InstantiateInlineWorkflowTemplateRequest.newBuilder()
     .setParent(formattedParent)
     .setTemplate(template)
     .build();
   OperationFuture<Empty, WorkflowMetadata> future = workflowTemplateServiceClient.instantiateInlineWorkflowTemplateOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

instantiateInlineWorkflowTemplateCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.InstantiateInlineWorkflowTemplateRequest,Operation> instantiateInlineWorkflowTemplateCallable()

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1beta2.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][google.cloud.dataproc.v1beta2.WorkflowMetadata].

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   String formattedParent = RegionName.format("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   InstantiateInlineWorkflowTemplateRequest request = InstantiateInlineWorkflowTemplateRequest.newBuilder()
     .setParent(formattedParent)
     .setTemplate(template)
     .build();
   ApiFuture<Operation> future = workflowTemplateServiceClient.instantiateInlineWorkflowTemplateCallable().futureCall(request);
   // Do something
   future.get();
 }
 

updateWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate updateWorkflowTemplate(com.google.cloud.dataproc.v1beta2.WorkflowTemplate template)

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   WorkflowTemplate response = workflowTemplateServiceClient.updateWorkflowTemplate(template);
 }
 

Parameters:

template - Required. The updated workflow template.

The `template.version` field must match the current version.

Throws:

ApiException - if the remote call fails

updateWorkflowTemplate

public final com.google.cloud.dataproc.v1beta2.WorkflowTemplate updateWorkflowTemplate(com.google.cloud.dataproc.v1beta2.UpdateWorkflowTemplateRequest request)

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   UpdateWorkflowTemplateRequest request = UpdateWorkflowTemplateRequest.newBuilder()
     .setTemplate(template)
     .build();
   WorkflowTemplate response = workflowTemplateServiceClient.updateWorkflowTemplate(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

updateWorkflowTemplateCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.UpdateWorkflowTemplateRequest,com.google.cloud.dataproc.v1beta2.WorkflowTemplate> updateWorkflowTemplateCallable()

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   UpdateWorkflowTemplateRequest request = UpdateWorkflowTemplateRequest.newBuilder()
     .setTemplate(template)
     .build();
   ApiFuture<WorkflowTemplate> future = workflowTemplateServiceClient.updateWorkflowTemplateCallable().futureCall(request);
   // Do something
   WorkflowTemplate response = future.get();
 }
 

listWorkflowTemplates

public final WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse listWorkflowTemplates(com.google.cloud.dataproc.v1beta2.RegionName parent)

Lists workflows that match the specified filter in the request.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   for (WorkflowTemplate element : workflowTemplateServiceClient.listWorkflowTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}`

Throws:

ApiException - if the remote call fails

listWorkflowTemplates

public final WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse listWorkflowTemplates(String parent)

Lists workflows that match the specified filter in the request.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   for (WorkflowTemplate element : workflowTemplateServiceClient.listWorkflowTemplates(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}`

Throws:

ApiException - if the remote call fails

listWorkflowTemplates

public final WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse listWorkflowTemplates(com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest request)

Lists workflows that match the specified filter in the request.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   ListWorkflowTemplatesRequest request = ListWorkflowTemplatesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (WorkflowTemplate element : workflowTemplateServiceClient.listWorkflowTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

listWorkflowTemplatesPagedCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest,WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse> listWorkflowTemplatesPagedCallable()

Lists workflows that match the specified filter in the request.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   ListWorkflowTemplatesRequest request = ListWorkflowTemplatesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListWorkflowTemplatesPagedResponse> future = workflowTemplateServiceClient.listWorkflowTemplatesPagedCallable().futureCall(request);
   // Do something
   for (WorkflowTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listWorkflowTemplatesCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesRequest,com.google.cloud.dataproc.v1beta2.ListWorkflowTemplatesResponse> listWorkflowTemplatesCallable()

Lists workflows that match the specified filter in the request.

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   ListWorkflowTemplatesRequest request = ListWorkflowTemplatesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListWorkflowTemplatesResponse response = workflowTemplateServiceClient.listWorkflowTemplatesCallable().call(request);
     for (WorkflowTemplate element : response.getTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteWorkflowTemplate

public final void deleteWorkflowTemplate(com.google.cloud.dataproc.v1beta2.WorkflowTemplateName name)

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   workflowTemplateServiceClient.deleteWorkflowTemplate(name);
 }
 

Parameters:

name - Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

Throws:

ApiException - if the remote call fails

deleteWorkflowTemplate

public final void deleteWorkflowTemplate(String name)

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   workflowTemplateServiceClient.deleteWorkflowTemplate(name.toString());
 }
 

Parameters:

name - Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

Throws:

ApiException - if the remote call fails

deleteWorkflowTemplate

public final void deleteWorkflowTemplate(com.google.cloud.dataproc.v1beta2.DeleteWorkflowTemplateRequest request)

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   DeleteWorkflowTemplateRequest request = DeleteWorkflowTemplateRequest.newBuilder()
     .setName(name.toString())
     .build();
   workflowTemplateServiceClient.deleteWorkflowTemplate(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

deleteWorkflowTemplateCallable

public final UnaryCallable<com.google.cloud.dataproc.v1beta2.DeleteWorkflowTemplateRequest,Empty> deleteWorkflowTemplateCallable()

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

Sample code:

 try (WorkflowTemplateServiceClient workflowTemplateServiceClient = WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name = WorkflowTemplateName.of("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]");
   DeleteWorkflowTemplateRequest request = DeleteWorkflowTemplateRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = workflowTemplateServiceClient.deleteWorkflowTemplateCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException