AutoscalingPolicyServiceClient (Google Cloud Dataproc Parent 4.0.8 API)

java.lang.Object
- com.google.cloud.dataproc.v1.AutoscalingPolicyServiceClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class AutoscalingPolicyServiceClient
extends Object
implements 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:

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

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AutoscalingPolicyServiceClient.ListAutoscalingPoliciesFixedSizeCollection`
`static class`	`AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPage`
`static class`	`AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AutoscalingPolicyServiceClient(AutoscalingPolicyServiceSettings settings)` Constructs an instance of AutoscalingPolicyServiceClient, using the given settings.
`protected`	`AutoscalingPolicyServiceClient(AutoscalingPolicyServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static AutoscalingPolicyServiceClient`	`create()` Constructs an instance of AutoscalingPolicyServiceClient with default settings.
`static AutoscalingPolicyServiceClient`	`create(AutoscalingPolicyServiceSettings settings)` Constructs an instance of AutoscalingPolicyServiceClient, using the given settings.
`static AutoscalingPolicyServiceClient`	`create(AutoscalingPolicyServiceStub stub)` Constructs an instance of AutoscalingPolicyServiceClient, using the given stub for making calls.
`AutoscalingPolicy`	`createAutoscalingPolicy(CreateAutoscalingPolicyRequest request)` Creates new autoscaling policy.
`AutoscalingPolicy`	`createAutoscalingPolicy(LocationName parent, AutoscalingPolicy policy)` Creates new autoscaling policy.
`AutoscalingPolicy`	`createAutoscalingPolicy(RegionName parent, AutoscalingPolicy policy)` Creates new autoscaling policy.
`AutoscalingPolicy`	`createAutoscalingPolicy(String parent, AutoscalingPolicy policy)` Creates new autoscaling policy.
`UnaryCallable<CreateAutoscalingPolicyRequest,AutoscalingPolicy>`	`createAutoscalingPolicyCallable()` Creates new autoscaling policy.
`void`	`deleteAutoscalingPolicy(AutoscalingPolicyName name)` Deletes an autoscaling policy.
`void`	`deleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest request)` Deletes an autoscaling policy.
`void`	`deleteAutoscalingPolicy(String name)` Deletes an autoscaling policy.
`UnaryCallable<DeleteAutoscalingPolicyRequest,Empty>`	`deleteAutoscalingPolicyCallable()` Deletes an autoscaling policy.
`AutoscalingPolicy`	`getAutoscalingPolicy(AutoscalingPolicyName name)` Retrieves autoscaling policy.
`AutoscalingPolicy`	`getAutoscalingPolicy(GetAutoscalingPolicyRequest request)` Retrieves autoscaling policy.
`AutoscalingPolicy`	`getAutoscalingPolicy(String name)` Retrieves autoscaling policy.
`UnaryCallable<GetAutoscalingPolicyRequest,AutoscalingPolicy>`	`getAutoscalingPolicyCallable()` Retrieves autoscaling policy.
`AutoscalingPolicyServiceSettings`	`getSettings()`
`AutoscalingPolicyServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse`	`listAutoscalingPolicies(ListAutoscalingPoliciesRequest request)` Lists autoscaling policies in the project.
`AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse`	`listAutoscalingPolicies(LocationName parent)` Lists autoscaling policies in the project.
`AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse`	`listAutoscalingPolicies(RegionName parent)` Lists autoscaling policies in the project.
`AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse`	`listAutoscalingPolicies(String parent)` Lists autoscaling policies in the project.
`UnaryCallable<ListAutoscalingPoliciesRequest,ListAutoscalingPoliciesResponse>`	`listAutoscalingPoliciesCallable()` Lists autoscaling policies in the project.
`UnaryCallable<ListAutoscalingPoliciesRequest,AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse>`	`listAutoscalingPoliciesPagedCallable()` Lists autoscaling policies in the project.
`void`	`shutdown()`
`void`	`shutdownNow()`
`AutoscalingPolicy`	`updateAutoscalingPolicy(AutoscalingPolicy policy)` Updates (replaces) autoscaling policy.
`AutoscalingPolicy`	`updateAutoscalingPolicy(UpdateAutoscalingPolicyRequest request)` Updates (replaces) autoscaling policy.
`UnaryCallable<UpdateAutoscalingPolicyRequest,AutoscalingPolicy>`	`updateAutoscalingPolicyCallable()` Updates (replaces) autoscaling policy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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
- AutoscalingPolicyServiceClient
```
protected AutoscalingPolicyServiceClient(AutoscalingPolicyServiceStub stub)
```

Method Detail

create

public static final AutoscalingPolicyServiceClient create()
                                                   throws IOException

Constructs an instance of AutoscalingPolicyServiceClient with default settings.

Throws:: IOException

create
```
public static final AutoscalingPolicyServiceClient create(AutoscalingPolicyServiceSettings settings)
                                                   throws IOException
```
Constructs an instance of AutoscalingPolicyServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final AutoscalingPolicyServiceClient create(AutoscalingPolicyServiceStub stub)
```
Constructs an instance of AutoscalingPolicyServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AutoscalingPolicyServiceSettings).

getSettings

public final AutoscalingPolicyServiceSettings getSettings()

getStub

public AutoscalingPolicyServiceStub getStub()

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:

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:

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:

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:: ApiException - if the remote call fails

createAutoscalingPolicyCallable

public final 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:: 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:: ApiException - if the remote call fails

updateAutoscalingPolicyCallable

public final 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:

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:

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:: ApiException - if the remote call fails

getAutoscalingPolicyCallable

public final 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:

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:

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:

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:: ApiException - if the remote call fails

listAutoscalingPoliciesPagedCallable

public final 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 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:

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:

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:: ApiException - if the remote call fails

deleteAutoscalingPolicyCallable

public final UnaryCallable<DeleteAutoscalingPolicyRequest,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();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class AutoscalingPolicyServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AutoscalingPolicyServiceClient

AutoscalingPolicyServiceClient

Method Detail

create

create

create

getSettings

getStub

createAutoscalingPolicy

createAutoscalingPolicy

createAutoscalingPolicy

createAutoscalingPolicy

createAutoscalingPolicyCallable

updateAutoscalingPolicy

updateAutoscalingPolicy

updateAutoscalingPolicyCallable

getAutoscalingPolicy

getAutoscalingPolicy

getAutoscalingPolicy

getAutoscalingPolicyCallable

listAutoscalingPolicies

listAutoscalingPolicies

listAutoscalingPolicies

listAutoscalingPolicies

listAutoscalingPoliciesPagedCallable

listAutoscalingPoliciesCallable

deleteAutoscalingPolicy

deleteAutoscalingPolicy

deleteAutoscalingPolicy

deleteAutoscalingPolicyCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination