Class AutoscalingPolicyServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable

    @Generated("by gapic-generator-java")
    public class AutoscalingPolicyServiceClient
    extends Object
    implements com.google.api.gax.core.BackgroundResource
    Service Description: The API interface for managing autoscaling policies 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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
         AutoscalingPolicyServiceClient.create()) {
       LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
       AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
       AutoscalingPolicy response =
           autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
     }
     

    Note: close() needs to be called on the AutoscalingPolicyServiceClient 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 AutoscalingPolicyServiceSettings 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
     AutoscalingPolicyServiceSettings autoscalingPolicyServiceSettings =
         AutoscalingPolicyServiceSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
         AutoscalingPolicyServiceClient.create(autoscalingPolicyServiceSettings);
     

    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
     AutoscalingPolicyServiceSettings autoscalingPolicyServiceSettings =
         AutoscalingPolicyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
     AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
         AutoscalingPolicyServiceClient.create(autoscalingPolicyServiceSettings);
     

    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
     AutoscalingPolicyServiceSettings autoscalingPolicyServiceSettings =
         AutoscalingPolicyServiceSettings.newHttpJsonBuilder().build();
     AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
         AutoscalingPolicyServiceClient.create(autoscalingPolicyServiceSettings);
     

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

    • Constructor Detail

      • AutoscalingPolicyServiceClient

        protected AutoscalingPolicyServiceClient​(AutoscalingPolicyServiceSettings settings)
                                          throws IOException
        Constructs an instance of AutoscalingPolicyServiceClient, 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

      • createAutoscalingPolicy

        public final AutoscalingPolicy createAutoscalingPolicy​(LocationName parent,
                                                               AutoscalingPolicy policy)
        Creates new autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
           AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
           AutoscalingPolicy response =
               autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
         }
         
        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.autoscalingPolicies.create`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.autoscalingPolicies.create`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        policy - Required. The autoscaling policy to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createAutoscalingPolicy

        public final AutoscalingPolicy createAutoscalingPolicy​(RegionName parent,
                                                               AutoscalingPolicy policy)
        Creates new autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
           AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
           AutoscalingPolicy response =
               autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
         }
         
        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.autoscalingPolicies.create`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.autoscalingPolicies.create`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        policy - Required. The autoscaling policy to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createAutoscalingPolicy

        public final AutoscalingPolicy createAutoscalingPolicy​(String parent,
                                                               AutoscalingPolicy policy)
        Creates new autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
           AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
           AutoscalingPolicy response =
               autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
         }
         
        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.autoscalingPolicies.create`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.autoscalingPolicies.create`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
        policy - Required. The autoscaling policy to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createAutoscalingPolicy

        public final AutoscalingPolicy createAutoscalingPolicy​(CreateAutoscalingPolicyRequest request)
        Creates new autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           CreateAutoscalingPolicyRequest request =
               CreateAutoscalingPolicyRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPolicy(AutoscalingPolicy.newBuilder().build())
                   .build();
           AutoscalingPolicy response = autoscalingPolicyServiceClient.createAutoscalingPolicy(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
      • createAutoscalingPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateAutoscalingPolicyRequest,​AutoscalingPolicy> createAutoscalingPolicyCallable()
        Creates new autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           CreateAutoscalingPolicyRequest request =
               CreateAutoscalingPolicyRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPolicy(AutoscalingPolicy.newBuilder().build())
                   .build();
           ApiFuture<AutoscalingPolicy> future =
               autoscalingPolicyServiceClient.createAutoscalingPolicyCallable().futureCall(request);
           // Do something.
           AutoscalingPolicy response = future.get();
         }
         
      • updateAutoscalingPolicy

        public final AutoscalingPolicy updateAutoscalingPolicy​(AutoscalingPolicy policy)
        Updates (replaces) autoscaling policy.

        Disabled check for update_mask, because all updates will be full replacements.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
           AutoscalingPolicy response = autoscalingPolicyServiceClient.updateAutoscalingPolicy(policy);
         }
         
        Parameters:
        policy - Required. The updated autoscaling policy.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • updateAutoscalingPolicy

        public final AutoscalingPolicy updateAutoscalingPolicy​(UpdateAutoscalingPolicyRequest request)
        Updates (replaces) autoscaling policy.

        Disabled check for update_mask, because all updates will be full replacements.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           UpdateAutoscalingPolicyRequest request =
               UpdateAutoscalingPolicyRequest.newBuilder()
                   .setPolicy(AutoscalingPolicy.newBuilder().build())
                   .build();
           AutoscalingPolicy response = autoscalingPolicyServiceClient.updateAutoscalingPolicy(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
      • updateAutoscalingPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateAutoscalingPolicyRequest,​AutoscalingPolicy> updateAutoscalingPolicyCallable()
        Updates (replaces) autoscaling policy.

        Disabled check for update_mask, because all updates will be full replacements.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           UpdateAutoscalingPolicyRequest request =
               UpdateAutoscalingPolicyRequest.newBuilder()
                   .setPolicy(AutoscalingPolicy.newBuilder().build())
                   .build();
           ApiFuture<AutoscalingPolicy> future =
               autoscalingPolicyServiceClient.updateAutoscalingPolicyCallable().futureCall(request);
           // Do something.
           AutoscalingPolicy response = future.get();
         }
         
      • getAutoscalingPolicy

        public final AutoscalingPolicy getAutoscalingPolicy​(AutoscalingPolicyName name)
        Retrieves autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           AutoscalingPolicyName name =
               AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                   "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]");
           AutoscalingPolicy response = autoscalingPolicyServiceClient.getAutoscalingPolicy(name);
         }
         
        Parameters:
        name - Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
        • For `projects.locations.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getAutoscalingPolicy

        public final AutoscalingPolicy getAutoscalingPolicy​(String name)
        Retrieves autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           String name =
               AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                       "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
                   .toString();
           AutoscalingPolicy response = autoscalingPolicyServiceClient.getAutoscalingPolicy(name);
         }
         
        Parameters:
        name - Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
        • For `projects.locations.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getAutoscalingPolicy

        public final AutoscalingPolicy getAutoscalingPolicy​(GetAutoscalingPolicyRequest request)
        Retrieves autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           GetAutoscalingPolicyRequest request =
               GetAutoscalingPolicyRequest.newBuilder()
                   .setName(
                       AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                               "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .build();
           AutoscalingPolicy response = autoscalingPolicyServiceClient.getAutoscalingPolicy(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
      • getAutoscalingPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetAutoscalingPolicyRequest,​AutoscalingPolicy> getAutoscalingPolicyCallable()
        Retrieves autoscaling policy.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           GetAutoscalingPolicyRequest request =
               GetAutoscalingPolicyRequest.newBuilder()
                   .setName(
                       AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                               "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .build();
           ApiFuture<AutoscalingPolicy> future =
               autoscalingPolicyServiceClient.getAutoscalingPolicyCallable().futureCall(request);
           // Do something.
           AutoscalingPolicy response = future.get();
         }
         
      • listAutoscalingPolicies

        public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies​(LocationName parent)
        Lists autoscaling policies in the project.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
           for (AutoscalingPolicy element :
               autoscalingPolicyServiceClient.listAutoscalingPolicies(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.autoscalingPolicies.list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.autoscalingPolicies.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
      • listAutoscalingPolicies

        public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies​(RegionName parent)
        Lists autoscaling policies in the project.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
           for (AutoscalingPolicy element :
               autoscalingPolicyServiceClient.listAutoscalingPolicies(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.autoscalingPolicies.list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.autoscalingPolicies.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
      • listAutoscalingPolicies

        public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies​(String parent)
        Lists autoscaling policies in the project.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
           for (AutoscalingPolicy element :
               autoscalingPolicyServiceClient.listAutoscalingPolicies(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.autoscalingPolicies.list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}`
        • For `projects.locations.autoscalingPolicies.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
      • listAutoscalingPolicies

        public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies​(ListAutoscalingPoliciesRequest request)
        Lists autoscaling policies in the project.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           ListAutoscalingPoliciesRequest request =
               ListAutoscalingPoliciesRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (AutoscalingPolicy element :
               autoscalingPolicyServiceClient.listAutoscalingPolicies(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
      • listAutoscalingPoliciesPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListAutoscalingPoliciesRequest,​AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse> listAutoscalingPoliciesPagedCallable()
        Lists autoscaling policies in the project.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           ListAutoscalingPoliciesRequest request =
               ListAutoscalingPoliciesRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<AutoscalingPolicy> future =
               autoscalingPolicyServiceClient.listAutoscalingPoliciesPagedCallable().futureCall(request);
           // Do something.
           for (AutoscalingPolicy element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listAutoscalingPoliciesCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListAutoscalingPoliciesRequest,​ListAutoscalingPoliciesResponse> listAutoscalingPoliciesCallable()
        Lists autoscaling policies in the project.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           ListAutoscalingPoliciesRequest request =
               ListAutoscalingPoliciesRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             ListAutoscalingPoliciesResponse response =
                 autoscalingPolicyServiceClient.listAutoscalingPoliciesCallable().call(request);
             for (AutoscalingPolicy element : response.getPoliciesList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • deleteAutoscalingPolicy

        public final void deleteAutoscalingPolicy​(AutoscalingPolicyName name)
        Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           AutoscalingPolicyName name =
               AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                   "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]");
           autoscalingPolicyServiceClient.deleteAutoscalingPolicy(name);
         }
         
        Parameters:
        name - Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
        • For `projects.locations.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteAutoscalingPolicy

        public final void deleteAutoscalingPolicy​(String name)
        Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           String name =
               AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                       "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
                   .toString();
           autoscalingPolicyServiceClient.deleteAutoscalingPolicy(name);
         }
         
        Parameters:
        name - Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
        • For `projects.regions.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
        • For `projects.locations.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteAutoscalingPolicy

        public final void deleteAutoscalingPolicy​(DeleteAutoscalingPolicyRequest request)
        Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           DeleteAutoscalingPolicyRequest request =
               DeleteAutoscalingPolicyRequest.newBuilder()
                   .setName(
                       AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                               "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .build();
           autoscalingPolicyServiceClient.deleteAutoscalingPolicy(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
      • deleteAutoscalingPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteAutoscalingPolicyRequest,​com.google.protobuf.Empty> deleteAutoscalingPolicyCallable()
        Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

        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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           DeleteAutoscalingPolicyRequest request =
               DeleteAutoscalingPolicyRequest.newBuilder()
                   .setName(
                       AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
                               "[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .build();
           ApiFuture<Empty> future =
               autoscalingPolicyServiceClient.deleteAutoscalingPolicyCallable().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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           SetIamPolicyRequest request =
               SetIamPolicyRequest.newBuilder()
                   .setResource(
                       AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                               "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .setPolicy(Policy.newBuilder().build())
                   .setUpdateMask(FieldMask.newBuilder().build())
                   .build();
           Policy response = autoscalingPolicyServiceClient.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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.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 =
               autoscalingPolicyServiceClient.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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           GetIamPolicyRequest request =
               GetIamPolicyRequest.newBuilder()
                   .setResource(
                       AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                               "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .setOptions(GetPolicyOptions.newBuilder().build())
                   .build();
           Policy response = autoscalingPolicyServiceClient.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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           GetIamPolicyRequest request =
               GetIamPolicyRequest.newBuilder()
                   .setResource(
                       AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                               "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .setOptions(GetPolicyOptions.newBuilder().build())
                   .build();
           ApiFuture<Policy> future =
               autoscalingPolicyServiceClient.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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           TestIamPermissionsRequest request =
               TestIamPermissionsRequest.newBuilder()
                   .setResource(
                       AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                               "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .addAllPermissions(new ArrayList<String>())
                   .build();
           TestIamPermissionsResponse response =
               autoscalingPolicyServiceClient.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 (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
             AutoscalingPolicyServiceClient.create()) {
           TestIamPermissionsRequest request =
               TestIamPermissionsRequest.newBuilder()
                   .setResource(
                       AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                               "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                           .toString())
                   .addAllPermissions(new ArrayList<String>())
                   .build();
           ApiFuture<TestIamPermissionsResponse> future =
               autoscalingPolicyServiceClient.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