Class AutoscalersClient (1.19.0)

Version 1.19.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 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

public class AutoscalersClient implements BackgroundResource

Service Description: The Autoscalers 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String autoscaler = "autoscaler517258967";
   Autoscaler response = autoscalersClient.get(project, zone, autoscaler);
 }
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AutoscalersSettings 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
 AutoscalersSettings autoscalersSettings =
     AutoscalersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AutoscalersClient autoscalersClient = AutoscalersClient.create(autoscalersSettings);
 

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
 AutoscalersSettings autoscalersSettings =
     AutoscalersSettings.newBuilder().setEndpoint(myEndpoint).build();
 AutoscalersClient autoscalersClient = AutoscalersClient.create(autoscalersSettings);
 

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

Inheritance

java.lang.Object > AutoscalersClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final AutoscalersClient create()

Constructs an instance of AutoscalersClient with default settings.

Returns

Type	Description
AutoscalersClient

Exceptions

Type	Description
IOException

create(AutoscalersSettings settings)

public static final AutoscalersClient create(AutoscalersSettings settings)

Constructs an instance of AutoscalersClient, 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	AutoscalersSettings

Returns

Type	Description
AutoscalersClient

Exceptions

Type	Description
IOException

create(AutoscalersStub stub)

public static final AutoscalersClient create(AutoscalersStub stub)

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

Parameter

Name	Description
stub	AutoscalersStub

Returns

Type	Description
AutoscalersClient

Constructors

AutoscalersClient(AutoscalersSettings settings)

protected AutoscalersClient(AutoscalersSettings settings)

Constructs an instance of AutoscalersClient, 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	AutoscalersSettings

AutoscalersClient(AutoscalersStub stub)

protected AutoscalersClient(AutoscalersStub stub)

Parameter

Name	Description
stub	AutoscalersStub

Methods

aggregatedList(AggregatedListAutoscalersRequest request)

public final AutoscalersClient.AggregatedListPagedResponse aggregatedList(AggregatedListAutoscalersRequest request)

Retrieves an aggregated list of autoscalers.

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   AggregatedListAutoscalersRequest request =
       AggregatedListAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, AutoscalersScopedList> element :
       autoscalersClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AutoscalersClient.AggregatedListPagedResponse

aggregatedList(String project)

public final AutoscalersClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of autoscalers.

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, AutoscalersScopedList> element :
       autoscalersClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
AutoscalersClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListAutoscalersRequest,AutoscalerAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of autoscalers.

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   AggregatedListAutoscalersRequest request =
       AggregatedListAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     AutoscalerAggregatedList response =
         autoscalersClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, AutoscalersScopedList> 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<AggregatedListAutoscalersRequest,AutoscalerAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListAutoscalersRequest,AutoscalersClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of autoscalers.

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   AggregatedListAutoscalersRequest request =
       AggregatedListAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, AutoscalersScopedList>> future =
       autoscalersClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, AutoscalersScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<AggregatedListAutoscalersRequest,AggregatedListPagedResponse>

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(DeleteAutoscalerRequest request)

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

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   DeleteAutoscalerRequest request =
       DeleteAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = autoscalersClient.deleteAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String zone, String autoscaler)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String zone, 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String autoscaler = "autoscaler517258967";
   Operation response = autoscalersClient.deleteAsync(project, zone, autoscaler).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String Name of the zone for this request.
autoscaler	String Name of the autoscaler to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   DeleteAutoscalerRequest request =
       DeleteAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = autoscalersClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteAutoscalerRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   DeleteAutoscalerRequest request =
       DeleteAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       autoscalersClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteAutoscalerRequest,Operation,Operation>

get(GetAutoscalerRequest request)

public final Autoscaler get(GetAutoscalerRequest request)

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   GetAutoscalerRequest request =
       GetAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Autoscaler response = autoscalersClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
Autoscaler

get(String project, String zone, String autoscaler)

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

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String autoscaler = "autoscaler517258967";
   Autoscaler response = autoscalersClient.get(project, zone, autoscaler);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String Name of the zone for this request.
autoscaler	String Name of the autoscaler to return.

Returns

Type	Description
Autoscaler

getCallable()

public final UnaryCallable<GetAutoscalerRequest,Autoscaler> getCallable()

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   GetAutoscalerRequest request =
       GetAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<Autoscaler> future = autoscalersClient.getCallable().futureCall(request);
   // Do something.
   Autoscaler response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetAutoscalerRequest,Autoscaler>

getSettings()

public final AutoscalersSettings getSettings()

Returns

Type	Description
AutoscalersSettings

getStub()

public AutoscalersStub getStub()

Returns

Type	Description
AutoscalersStub

insertAsync(InsertAutoscalerRequest request)

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

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   InsertAutoscalerRequest request =
       InsertAutoscalerRequest.newBuilder()
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = autoscalersClient.insertAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String zone, Autoscaler autoscalerResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String zone, 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response = autoscalersClient.insertAsync(project, zone, autoscalerResource).get();
 }
 

Parameters

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   InsertAutoscalerRequest request =
       InsertAutoscalerRequest.newBuilder()
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = autoscalersClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertAutoscalerRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   InsertAutoscalerRequest request =
       InsertAutoscalerRequest.newBuilder()
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       autoscalersClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<InsertAutoscalerRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListAutoscalersRequest request)

public final AutoscalersClient.ListPagedResponse list(ListAutoscalersRequest request)

Retrieves a list of autoscalers contained within the specified zone.

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   ListAutoscalersRequest request =
       ListAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (Autoscaler element : autoscalersClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AutoscalersClient.ListPagedResponse

list(String project, String zone)

public final AutoscalersClient.ListPagedResponse list(String project, String zone)

Retrieves a list of autoscalers contained within the specified zone.

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (Autoscaler element : autoscalersClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String Name of the zone for this request.

Returns

Type	Description
AutoscalersClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListAutoscalersRequest,AutoscalerList> listCallable()

Retrieves a list of autoscalers contained within the specified zone.

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   ListAutoscalersRequest request =
       ListAutoscalersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     AutoscalerList response = autoscalersClient.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<ListAutoscalersRequest,AutoscalerList>

listPagedCallable()

public final UnaryCallable<ListAutoscalersRequest,AutoscalersClient.ListPagedResponse> listPagedCallable()

Retrieves a list of autoscalers contained within the specified zone.

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

Returns

Type	Description
UnaryCallable<ListAutoscalersRequest,ListPagedResponse>

patchAsync(PatchAutoscalerRequest request)

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

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   PatchAutoscalerRequest request =
       PatchAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = autoscalersClient.patchAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String zone, Autoscaler autoscalerResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String zone, 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response = autoscalersClient.patchAsync(project, zone, autoscalerResource).get();
 }
 

Parameters

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   PatchAutoscalerRequest request =
       PatchAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = autoscalersClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<PatchAutoscalerRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   PatchAutoscalerRequest request =
       PatchAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       autoscalersClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<PatchAutoscalerRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateAutoscalerRequest request)

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

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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   UpdateAutoscalerRequest request =
       UpdateAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = autoscalersClient.updateAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

updateAsync(String project, String zone, Autoscaler autoscalerResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String zone, 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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response = autoscalersClient.updateAsync(project, zone, autoscalerResource).get();
 }
 

Parameters

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

Returns

Type	Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   UpdateAutoscalerRequest request =
       UpdateAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = autoscalersClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateAutoscalerRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateAutoscalerRequest,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 (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
   UpdateAutoscalerRequest request =
       UpdateAutoscalerRequest.newBuilder()
           .setAutoscaler("autoscaler517258967")
           .setAutoscalerResource(Autoscaler.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       autoscalersClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<UpdateAutoscalerRequest,Operation,Operation>