Class RegionAutoscalersClient (1.43.0)

Version 1.43.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

GitHub Repository

Product Reference

Service Description: The RegionAutoscalers 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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String autoscaler = "autoscaler517258967";
   Autoscaler response = regionAutoscalersClient.get(project, region, autoscaler);
 }
 

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

Method	Description	Method Variants
Delete	Deletes the specified autoscaler.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteRegionAutoscalerRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. deleteAsync(String project, String region, String autoscaler) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified autoscaler.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetRegionAutoscalerRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String region, String autoscaler) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
Insert	Creates an autoscaler in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertRegionAutoscalerRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. insertAsync(String project, String region, Autoscaler autoscalerResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Retrieves a list of autoscalers contained within the specified region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListRegionAutoscalersRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
Patch	Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchAsync(PatchRegionAutoscalerRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. patchAsync(String project, String region, Autoscaler autoscalerResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchOperationCallable() patchCallable()
Update	Updates an autoscaler in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAsync(UpdateRegionAutoscalerRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. updateAsync(String project, String region, Autoscaler autoscalerResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateOperationCallable() updateCallable()

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 RegionAutoscalersSettings 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
 RegionAutoscalersSettings regionAutoscalersSettings =
     RegionAutoscalersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionAutoscalersClient regionAutoscalersClient =
     RegionAutoscalersClient.create(regionAutoscalersSettings);
 

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
 RegionAutoscalersSettings regionAutoscalersSettings =
     RegionAutoscalersSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionAutoscalersClient regionAutoscalersClient =
     RegionAutoscalersClient.create(regionAutoscalersSettings);
 

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

Inheritance

java.lang.Object > RegionAutoscalersClient

Static Methods

create()

public static final RegionAutoscalersClient create()

Constructs an instance of RegionAutoscalersClient with default settings.

Returns
Type	Description
RegionAutoscalersClient

Exceptions
Type	Description
IOException

create(RegionAutoscalersSettings settings)

public static final RegionAutoscalersClient create(RegionAutoscalersSettings settings)

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

Parameter
Name	Description
settings	RegionAutoscalersSettings

Returns
Type	Description
RegionAutoscalersClient

Exceptions
Type	Description
IOException

create(RegionAutoscalersStub stub)

public static final RegionAutoscalersClient create(RegionAutoscalersStub stub)

Constructs an instance of RegionAutoscalersClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionAutoscalersSettings).

Parameter
Name	Description
stub	RegionAutoscalersStub

Returns
Type	Description
RegionAutoscalersClient

Constructors

RegionAutoscalersClient(RegionAutoscalersSettings settings)

protected RegionAutoscalersClient(RegionAutoscalersSettings settings)

Constructs an instance of RegionAutoscalersClient, 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.

Parameter
Name	Description
settings	RegionAutoscalersSettings

RegionAutoscalersClient(RegionAutoscalersStub stub)

protected RegionAutoscalersClient(RegionAutoscalersStub stub)

Parameter
Name	Description
stub	RegionAutoscalersStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteRegionAutoscalerRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionAutoscalerRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Deletes the specified autoscaler.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   DeleteRegionAutoscalerRequest request =
       DeleteRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionAutoscalersClient.deleteAsync(request).get();
 }
 

Parameter
Name	Description
request	DeleteRegionAutoscalerRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String autoscaler)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String autoscaler)

Deletes the specified autoscaler.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String autoscaler = "autoscaler517258967";
   Operation response = regionAutoscalersClient.deleteAsync(project, region, autoscaler).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
autoscaler	String Name of the autoscaler to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRegionAutoscalerRequest,Operation> deleteCallable()

Deletes the specified autoscaler.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   DeleteRegionAutoscalerRequest request =
       DeleteRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionAutoscalersClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteRegionAutoscalerRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteRegionAutoscalerRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified autoscaler.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   DeleteRegionAutoscalerRequest request =
       DeleteRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionAutoscalersClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteRegionAutoscalerRequest,Operation,Operation>

get(GetRegionAutoscalerRequest request)

public final Autoscaler get(GetRegionAutoscalerRequest request)

Returns the specified autoscaler.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   GetRegionAutoscalerRequest request =
       GetRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   Autoscaler response = regionAutoscalersClient.get(request);
 }
 

Parameter
Name	Description
request	GetRegionAutoscalerRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Autoscaler

get(String project, String region, String autoscaler)

public final Autoscaler get(String project, String region, String autoscaler)

Returns the specified autoscaler.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String autoscaler = "autoscaler517258967";
   Autoscaler response = regionAutoscalersClient.get(project, region, autoscaler);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
autoscaler	String Name of the autoscaler to return.

Returns
Type	Description
Autoscaler

getCallable()

public final UnaryCallable<GetRegionAutoscalerRequest,Autoscaler> getCallable()

Returns the specified autoscaler.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   GetRegionAutoscalerRequest request =
       GetRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<Autoscaler> future = regionAutoscalersClient.getCallable().futureCall(request);
   // Do something.
   Autoscaler response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetRegionAutoscalerRequest,Autoscaler>

getSettings()

public final RegionAutoscalersSettings getSettings()

Returns
Type	Description
RegionAutoscalersSettings

getStub()

public RegionAutoscalersStub getStub()

Returns
Type	Description
RegionAutoscalersStub

insertAsync(InsertRegionAutoscalerRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRegionAutoscalerRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   InsertRegionAutoscalerRequest request =
       InsertRegionAutoscalerRequest.newBuilder()
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionAutoscalersClient.insertAsync(request).get();
 }
 

Parameter
Name	Description
request	InsertRegionAutoscalerRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, Autoscaler autoscalerResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, Autoscaler autoscalerResource)

Creates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response =
       regionAutoscalersClient.insertAsync(project, region, autoscalerResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
autoscalerResource	Autoscaler The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRegionAutoscalerRequest,Operation> insertCallable()

Creates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   InsertRegionAutoscalerRequest request =
       InsertRegionAutoscalerRequest.newBuilder()
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionAutoscalersClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertRegionAutoscalerRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertRegionAutoscalerRequest,Operation,Operation> insertOperationCallable()

Creates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   InsertRegionAutoscalerRequest request =
       InsertRegionAutoscalerRequest.newBuilder()
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionAutoscalersClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<InsertRegionAutoscalerRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListRegionAutoscalersRequest request)

public final RegionAutoscalersClient.ListPagedResponse list(ListRegionAutoscalersRequest request)

Retrieves a list of autoscalers contained within the specified region.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   ListRegionAutoscalersRequest request =
       ListRegionAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (Autoscaler element : regionAutoscalersClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListRegionAutoscalersRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
RegionAutoscalersClient.ListPagedResponse

list(String project, String region)

public final RegionAutoscalersClient.ListPagedResponse list(String project, String region)

Retrieves a list of autoscalers contained within the specified region.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (Autoscaler element : regionAutoscalersClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.

Returns
Type	Description
RegionAutoscalersClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionAutoscalersRequest,RegionAutoscalerList> listCallable()

Retrieves a list of autoscalers contained within the specified region.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   ListRegionAutoscalersRequest request =
       ListRegionAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RegionAutoscalerList response = regionAutoscalersClient.listCallable().call(request);
     for (Autoscaler element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRegionAutoscalersRequest,RegionAutoscalerList>

listPagedCallable()

public final UnaryCallable<ListRegionAutoscalersRequest,RegionAutoscalersClient.ListPagedResponse> listPagedCallable()

Retrieves a list of autoscalers contained within the specified region.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   ListRegionAutoscalersRequest request =
       ListRegionAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Autoscaler> future =
       regionAutoscalersClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Autoscaler element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRegionAutoscalersRequest,ListPagedResponse>

patchAsync(PatchRegionAutoscalerRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchRegionAutoscalerRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   PatchRegionAutoscalerRequest request =
       PatchRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionAutoscalersClient.patchAsync(request).get();
 }
 

Parameter
Name	Description
request	PatchRegionAutoscalerRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, Autoscaler autoscalerResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, Autoscaler autoscalerResource)

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response =
       regionAutoscalersClient.patchAsync(project, region, autoscalerResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
autoscalerResource	Autoscaler The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchRegionAutoscalerRequest,Operation> patchCallable()

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   PatchRegionAutoscalerRequest request =
       PatchRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionAutoscalersClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<PatchRegionAutoscalerRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchRegionAutoscalerRequest,Operation,Operation> patchOperationCallable()

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   PatchRegionAutoscalerRequest request =
       PatchRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionAutoscalersClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<PatchRegionAutoscalerRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateRegionAutoscalerRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateRegionAutoscalerRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Updates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   UpdateRegionAutoscalerRequest request =
       UpdateRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionAutoscalersClient.updateAsync(request).get();
 }
 

Parameter
Name	Description
request	UpdateRegionAutoscalerRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

updateAsync(String project, String region, Autoscaler autoscalerResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String region, Autoscaler autoscalerResource)

Updates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response =
       regionAutoscalersClient.updateAsync(project, region, autoscalerResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
autoscalerResource	Autoscaler The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateRegionAutoscalerRequest,Operation> updateCallable()

Updates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   UpdateRegionAutoscalerRequest request =
       UpdateRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionAutoscalersClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateRegionAutoscalerRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateRegionAutoscalerRequest,Operation,Operation> updateOperationCallable()

Updates an autoscaler in the specified project using the data included in the request.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
   UpdateRegionAutoscalerRequest request =
       UpdateRegionAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionAutoscalersClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<UpdateRegionAutoscalerRequest,Operation,Operation>