Package com.google.cloud.dataproc.v1

Class WorkflowTemplateServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class WorkflowTemplateServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: The API interface for managing Workflow Templates in the 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: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   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: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WorkflowTemplateServiceSettings workflowTemplateServiceSettings =
     WorkflowTemplateServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create(workflowTemplateServiceSettings);

    To customize the endpoint: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WorkflowTemplateServiceSettings workflowTemplateServiceSettings =
     WorkflowTemplateServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create(workflowTemplateServiceSettings);

    To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WorkflowTemplateServiceSettings workflowTemplateServiceSettings =
     WorkflowTemplateServiceSettings.newHttpJsonBuilder().build();
 WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create(workflowTemplateServiceSettings);

    Please refer to the GitHub repository's samples for more quickstart code snippets.

    • 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

    • Method Detail

      • create

        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 using create(WorkflowTemplateServiceSettings).

      • getOperationsClient

        public final com.google.longrunning.OperationsClient getOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • getHttpJsonOperationsClient

        @BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
        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 WorkflowTemplate createWorkflowTemplate​(LocationName parent,
                                                     WorkflowTemplate template)
        Creates new workflow template.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   WorkflowTemplate response =
       workflowTemplateServiceClient.createWorkflowTemplate(parent, template);
 }
        Parameters:
        parent - 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}`
        template - Required. The Dataproc workflow template to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createWorkflowTemplate

        public final WorkflowTemplate createWorkflowTemplate​(RegionName parent,
                                                     WorkflowTemplate template)
        Creates new workflow template.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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 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}`
        template - Required. The Dataproc workflow template to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createWorkflowTemplate

        public final WorkflowTemplate createWorkflowTemplate​(String parent,
                                                     WorkflowTemplate template)
        Creates new workflow template.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   String parent = RegionName.of("[PROJECT]", "[REGION]").toString();
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   WorkflowTemplate response =
       workflowTemplateServiceClient.createWorkflowTemplate(parent, template);
 }
        Parameters:
        parent - 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}`
        template - Required. The Dataproc workflow template to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createWorkflowTemplate

        public final WorkflowTemplate createWorkflowTemplate​(CreateWorkflowTemplateRequest request)
        Creates new workflow template.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   CreateWorkflowTemplateRequest request =
       CreateWorkflowTemplateRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setTemplate(WorkflowTemplate.newBuilder().build())
           .build();
   WorkflowTemplate response = workflowTemplateServiceClient.createWorkflowTemplate(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createWorkflowTemplateCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateWorkflowTemplateRequest,​WorkflowTemplate> createWorkflowTemplateCallable()
        Creates new workflow template.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   CreateWorkflowTemplateRequest request =
       CreateWorkflowTemplateRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setTemplate(WorkflowTemplate.newBuilder().build())
           .build();
   ApiFuture<WorkflowTemplate> future =
       workflowTemplateServiceClient.createWorkflowTemplateCallable().futureCall(request);
   // Do something.
   WorkflowTemplate response = future.get();
 }

      • getWorkflowTemplate

        public final WorkflowTemplate getWorkflowTemplate​(WorkflowTemplateName name)
        Retrieves the latest workflow template.

        Can retrieve previously instantiated template by specifying optional version parameter.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name =
       WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
           "[PROJECT]", "[LOCATION]", "[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.
        • For `projects.regions.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getWorkflowTemplate

        public final WorkflowTemplate getWorkflowTemplate​(String name)
        Retrieves the latest workflow template.

        Can retrieve previously instantiated template by specifying optional version parameter.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   String name =
       WorkflowTemplateName.ofProjectRegionWorkflowTemplateName(
               "[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]")
           .toString();
   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.
        • For `projects.regions.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getWorkflowTemplate

        public final WorkflowTemplate getWorkflowTemplate​(GetWorkflowTemplateRequest request)
        Retrieves the latest workflow template.

        Can retrieve previously instantiated template by specifying optional version parameter.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   GetWorkflowTemplateRequest request =
       GetWorkflowTemplateRequest.newBuilder()
           .setName(
               WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
                       "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]")
                   .toString())
           .setVersion(351608024)
           .build();
   WorkflowTemplate response = workflowTemplateServiceClient.getWorkflowTemplate(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getWorkflowTemplateCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetWorkflowTemplateRequest,​WorkflowTemplate> getWorkflowTemplateCallable()
        Retrieves the latest workflow template.

        Can retrieve previously instantiated template by specifying optional version parameter.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   GetWorkflowTemplateRequest request =
       GetWorkflowTemplateRequest.newBuilder()
           .setName(
               WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
                       "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]")
                   .toString())
           .setVersion(351608024)
           .build();
   ApiFuture<WorkflowTemplate> future =
       workflowTemplateServiceClient.getWorkflowTemplateCallable().futureCall(request);
   // Do something.
   WorkflowTemplate response = future.get();
 }

      • instantiateWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateWorkflowTemplateAsync​(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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name =
       WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
           "[PROJECT]", "[LOCATION]", "[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.
        • For `projects.regions.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   String name =
       WorkflowTemplateName.ofProjectRegionWorkflowTemplateName(
               "[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]")
           .toString();
   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.
        • For `projects.regions.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateWorkflowTemplateAsync​(WorkflowTemplateName name,
                                                                                                                                               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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name =
       WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
           "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]");
   Map<String, String> parameters = new HashMap<>();
   workflowTemplateServiceClient.instantiateWorkflowTemplateAsync(name, parameters).get();
 }
        Parameters:
        name - Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        parameters - Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateWorkflowTemplateAsync​(String name,
                                                                                                                                               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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   String name =
       WorkflowTemplateName.ofProjectRegionWorkflowTemplateName(
               "[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]")
           .toString();
   Map<String, String> parameters = new HashMap<>();
   workflowTemplateServiceClient.instantiateWorkflowTemplateAsync(name, parameters).get();
 }
        Parameters:
        name - Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        parameters - Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateWorkflowTemplateAsync​(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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   InstantiateWorkflowTemplateRequest request =
       InstantiateWorkflowTemplateRequest.newBuilder()
           .setName(
               WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
                       "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]")
                   .toString())
           .setVersion(351608024)
           .setRequestId("requestId693933066")
           .putAllParameters(new HashMap<String, String>())
           .build();
   workflowTemplateServiceClient.instantiateWorkflowTemplateAsync(request).get();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateWorkflowTemplateOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<InstantiateWorkflowTemplateRequest,​com.google.protobuf.Empty,​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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   InstantiateWorkflowTemplateRequest request =
       InstantiateWorkflowTemplateRequest.newBuilder()
           .setName(
               WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
                       "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]")
                   .toString())
           .setVersion(351608024)
           .setRequestId("requestId693933066")
           .putAllParameters(new HashMap<String, String>())
           .build();
   OperationFuture<Empty, WorkflowMetadata> future =
       workflowTemplateServiceClient
           .instantiateWorkflowTemplateOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

      • instantiateWorkflowTemplateCallable

        public final com.google.api.gax.rpc.UnaryCallable<InstantiateWorkflowTemplateRequest,​com.google.longrunning.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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   InstantiateWorkflowTemplateRequest request =
       InstantiateWorkflowTemplateRequest.newBuilder()
           .setName(
               WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
                       "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]")
                   .toString())
           .setVersion(351608024)
           .setRequestId("requestId693933066")
           .putAllParameters(new HashMap<String, String>())
           .build();
   ApiFuture<Operation> future =
       workflowTemplateServiceClient.instantiateWorkflowTemplateCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • instantiateInlineWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateInlineWorkflowTemplateAsync​(LocationName parent,
                                                                                                                                                     WorkflowTemplate template)
        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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   workflowTemplateServiceClient.instantiateInlineWorkflowTemplateAsync(parent, template).get();
 }
        Parameters:
        parent - Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates,instantiateinline`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.workflowTemplates.instantiateinline`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        template - Required. The workflow template to instantiate.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateInlineWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateInlineWorkflowTemplateAsync​(RegionName parent,
                                                                                                                                                     WorkflowTemplate template)
        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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   workflowTemplateServiceClient.instantiateInlineWorkflowTemplateAsync(parent, template).get();
 }
        Parameters:
        parent - Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates,instantiateinline`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.workflowTemplates.instantiateinline`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        template - Required. The workflow template to instantiate.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateInlineWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateInlineWorkflowTemplateAsync​(String parent,
                                                                                                                                                     WorkflowTemplate template)
        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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   String parent = RegionName.of("[PROJECT]", "[REGION]").toString();
   WorkflowTemplate template = WorkflowTemplate.newBuilder().build();
   workflowTemplateServiceClient.instantiateInlineWorkflowTemplateAsync(parent, template).get();
 }
        Parameters:
        parent - Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates,instantiateinline`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.workflowTemplates.instantiateinline`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        template - Required. The workflow template to instantiate.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateInlineWorkflowTemplateAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​WorkflowMetadata> instantiateInlineWorkflowTemplateAsync​(InstantiateInlineWorkflowTemplateRequest request)
        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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   InstantiateInlineWorkflowTemplateRequest request =
       InstantiateInlineWorkflowTemplateRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setTemplate(WorkflowTemplate.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   workflowTemplateServiceClient.instantiateInlineWorkflowTemplateAsync(request).get();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • instantiateInlineWorkflowTemplateOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<InstantiateInlineWorkflowTemplateRequest,​com.google.protobuf.Empty,​WorkflowMetadata> instantiateInlineWorkflowTemplateOperationCallable()
        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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   InstantiateInlineWorkflowTemplateRequest request =
       InstantiateInlineWorkflowTemplateRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setTemplate(WorkflowTemplate.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, WorkflowMetadata> future =
       workflowTemplateServiceClient
           .instantiateInlineWorkflowTemplateOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

      • instantiateInlineWorkflowTemplateCallable

        public final com.google.api.gax.rpc.UnaryCallable<InstantiateInlineWorkflowTemplateRequest,​com.google.longrunning.Operation> instantiateInlineWorkflowTemplateCallable()
        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](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   InstantiateInlineWorkflowTemplateRequest request =
       InstantiateInlineWorkflowTemplateRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setTemplate(WorkflowTemplate.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       workflowTemplateServiceClient
           .instantiateInlineWorkflowTemplateCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

      • updateWorkflowTemplate

        public final WorkflowTemplate updateWorkflowTemplate​(WorkflowTemplate template)
        Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateWorkflowTemplate

        public final WorkflowTemplate updateWorkflowTemplate​(UpdateWorkflowTemplateRequest request)
        Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   UpdateWorkflowTemplateRequest request =
       UpdateWorkflowTemplateRequest.newBuilder()
           .setTemplate(WorkflowTemplate.newBuilder().build())
           .build();
   WorkflowTemplate response = workflowTemplateServiceClient.updateWorkflowTemplate(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateWorkflowTemplateCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateWorkflowTemplateRequest,​WorkflowTemplate> updateWorkflowTemplateCallable()
        Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   UpdateWorkflowTemplateRequest request =
       UpdateWorkflowTemplateRequest.newBuilder()
           .setTemplate(WorkflowTemplate.newBuilder().build())
           .build();
   ApiFuture<WorkflowTemplate> future =
       workflowTemplateServiceClient.updateWorkflowTemplateCallable().futureCall(request);
   // Do something.
   WorkflowTemplate response = future.get();
 }

      • listWorkflowTemplates

        public final WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse listWorkflowTemplates​(LocationName parent)
        Lists workflows that match the specified filter in the request.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (WorkflowTemplate element :
       workflowTemplateServiceClient.listWorkflowTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates,list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.workflowTemplates.list`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listWorkflowTemplates

        public final WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse listWorkflowTemplates​(RegionName parent)
        Lists workflows that match the specified filter in the request.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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 or location, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates,list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.workflowTemplates.list`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.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: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   String parent = RegionName.of("[PROJECT]", "[REGION]").toString();
   for (WorkflowTemplate element :
       workflowTemplateServiceClient.listWorkflowTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates,list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.workflowTemplates.list`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listWorkflowTemplates

        public final WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse listWorkflowTemplates​(ListWorkflowTemplatesRequest request)
        Lists workflows that match the specified filter in the request.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   ListWorkflowTemplatesRequest request =
       ListWorkflowTemplatesRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listWorkflowTemplatesPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListWorkflowTemplatesRequest,​WorkflowTemplateServiceClient.ListWorkflowTemplatesPagedResponse> listWorkflowTemplatesPagedCallable()
        Lists workflows that match the specified filter in the request.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   ListWorkflowTemplatesRequest request =
       ListWorkflowTemplatesRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<WorkflowTemplate> future =
       workflowTemplateServiceClient.listWorkflowTemplatesPagedCallable().futureCall(request);
   // Do something.
   for (WorkflowTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listWorkflowTemplatesCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListWorkflowTemplatesRequest,​ListWorkflowTemplatesResponse> listWorkflowTemplatesCallable()
        Lists workflows that match the specified filter in the request.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   ListWorkflowTemplatesRequest request =
       ListWorkflowTemplatesRequest.newBuilder()
           .setParent(RegionName.of("[PROJECT]", "[REGION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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​(WorkflowTemplateName name)
        Deletes a workflow template. It does not cancel in-progress workflows.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   WorkflowTemplateName name =
       WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
           "[PROJECT]", "[LOCATION]", "[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.
        • For `projects.regions.workflowTemplates.delete`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        Throws:
        com.google.api.gax.rpc.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: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   String name =
       WorkflowTemplateName.ofProjectRegionWorkflowTemplateName(
               "[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]")
           .toString();
   workflowTemplateServiceClient.deleteWorkflowTemplate(name);
 }
        Parameters:
        name - Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.workflowTemplates.delete`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
        • For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteWorkflowTemplate

        public final void deleteWorkflowTemplate​(DeleteWorkflowTemplateRequest request)
        Deletes a workflow template. It does not cancel in-progress workflows.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   DeleteWorkflowTemplateRequest request =
       DeleteWorkflowTemplateRequest.newBuilder()
           .setName(
               WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
                       "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]")
                   .toString())
           .setVersion(351608024)
           .build();
   workflowTemplateServiceClient.deleteWorkflowTemplate(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteWorkflowTemplateCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteWorkflowTemplateRequest,​com.google.protobuf.Empty> deleteWorkflowTemplateCallable()
        Deletes a workflow template. It does not cancel in-progress workflows.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   DeleteWorkflowTemplateRequest request =
       DeleteWorkflowTemplateRequest.newBuilder()
           .setName(
               WorkflowTemplateName.ofProjectLocationWorkflowTemplateName(
                       "[PROJECT]", "[LOCATION]", "[WORKFLOW_TEMPLATE]")
                   .toString())
           .setVersion(351608024)
           .build();
   ApiFuture<Empty> future =
       workflowTemplateServiceClient.deleteWorkflowTemplateCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • setIamPolicy

        public final com.google.iam.v1.Policy setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request)
        Sets the access control policy on the specified resource. Replacesany existing policy.

        Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = workflowTemplateServiceClient.setIamPolicy(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • setIamPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,​com.google.iam.v1.Policy> setIamPolicyCallable()
        Sets the access control policy on the specified resource. Replacesany existing policy.

        Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       workflowTemplateServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

      • getIamPolicy

        public final com.google.iam.v1.Policy getIamPolicy​(com.google.iam.v1.GetIamPolicyRequest request)
        Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = workflowTemplateServiceClient.getIamPolicy(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getIamPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,​com.google.iam.v1.Policy> getIamPolicyCallable()
        Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       workflowTemplateServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

      • testIamPermissions

        public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request)
        Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

        Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       workflowTemplateServiceClient.testIamPermissions(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • testIamPermissionsCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,​com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
        Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

        Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WorkflowTemplateServiceClient workflowTemplateServiceClient =
     WorkflowTemplateServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       workflowTemplateServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource