Class RegionAutoscalersClient (1.59.0)

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().

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.

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

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

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.

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();
 }
 

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();
 }
 

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();
 }
 

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 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);
 }
 

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);
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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);
   }
 }
 

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);
   }
 }
 

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;
     }
   }
 }
 

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);
   }
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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();
 }
 

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();
 }