com.google.cloud.compute.v1

Class AutoscalerClient

java.lang.Object

com.google.cloud.compute.v1.AutoscalerClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class AutoscalerClient
extends Object
implements BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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:

 
 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneAutoscalerName autoscaler = ProjectZoneAutoscalerName.of("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   Operation response = autoscalerClient.deleteAutoscaler(autoscaler);
 }
 
 

Note: close() needs to be called on the autoscalerClient 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 AutoscalerSettings to create(). For example:

To customize credentials:

 
 AutoscalerSettings autoscalerSettings =
     AutoscalerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AutoscalerClient autoscalerClient =
     AutoscalerClient.create(autoscalerSettings);
 
 

To customize the endpoint:

 
 AutoscalerSettings autoscalerSettings =
     AutoscalerSettings.newBuilder().setEndpoint(myEndpoint).build();
 AutoscalerClient autoscalerClient =
     AutoscalerClient.create(autoscalerSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoscalerClient.AggregatedListAutoscalersFixedSizeCollection
static class	AutoscalerClient.AggregatedListAutoscalersPage
static class	AutoscalerClient.AggregatedListAutoscalersPagedResponse
static class	AutoscalerClient.ListAutoscalersFixedSizeCollection
static class	AutoscalerClient.ListAutoscalersPage
static class	AutoscalerClient.ListAutoscalersPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AutoscalerClient(AutoscalerSettings settings) Constructs an instance of AutoscalerClient, using the given settings.
protected	AutoscalerClient(AutoscalerStub stub)

Method Summary

Modifier and Type	Method and Description
AutoscalerClient.AggregatedListAutoscalersPagedResponse	aggregatedListAutoscalers(AggregatedListAutoscalersHttpRequest request) Retrieves an aggregated list of autoscalers.
AutoscalerClient.AggregatedListAutoscalersPagedResponse	aggregatedListAutoscalers(ProjectName project) Retrieves an aggregated list of autoscalers.
AutoscalerClient.AggregatedListAutoscalersPagedResponse	aggregatedListAutoscalers(String project) Retrieves an aggregated list of autoscalers.
UnaryCallable<AggregatedListAutoscalersHttpRequest,AutoscalerAggregatedList>	aggregatedListAutoscalersCallable() Retrieves an aggregated list of autoscalers.
UnaryCallable<AggregatedListAutoscalersHttpRequest,AutoscalerClient.AggregatedListAutoscalersPagedResponse>	aggregatedListAutoscalersPagedCallable() Retrieves an aggregated list of autoscalers.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static AutoscalerClient	create() Constructs an instance of AutoscalerClient with default settings.
static AutoscalerClient	create(AutoscalerSettings settings) Constructs an instance of AutoscalerClient, using the given settings.
static AutoscalerClient	create(AutoscalerStub stub) Constructs an instance of AutoscalerClient, using the given stub for making calls.
Operation	deleteAutoscaler(DeleteAutoscalerHttpRequest request) Deletes the specified autoscaler.
Operation	deleteAutoscaler(ProjectZoneAutoscalerName autoscaler) Deletes the specified autoscaler.
Operation	deleteAutoscaler(String autoscaler) Deletes the specified autoscaler.
UnaryCallable<DeleteAutoscalerHttpRequest,Operation>	deleteAutoscalerCallable() Deletes the specified autoscaler.
Autoscaler	getAutoscaler(GetAutoscalerHttpRequest request) Returns the specified autoscaler resource.
Autoscaler	getAutoscaler(ProjectZoneAutoscalerName autoscaler) Returns the specified autoscaler resource.
Autoscaler	getAutoscaler(String autoscaler) Returns the specified autoscaler resource.
UnaryCallable<GetAutoscalerHttpRequest,Autoscaler>	getAutoscalerCallable() Returns the specified autoscaler resource.
AutoscalerSettings	getSettings()
AutoscalerStub	getStub()
Operation	insertAutoscaler(InsertAutoscalerHttpRequest request) Creates an autoscaler in the specified project using the data included in the request.
Operation	insertAutoscaler(ProjectZoneName zone, Autoscaler autoscalerResource) Creates an autoscaler in the specified project using the data included in the request.
Operation	insertAutoscaler(String zone, Autoscaler autoscalerResource) Creates an autoscaler in the specified project using the data included in the request.
UnaryCallable<InsertAutoscalerHttpRequest,Operation>	insertAutoscalerCallable() Creates an autoscaler in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
AutoscalerClient.ListAutoscalersPagedResponse	listAutoscalers(ListAutoscalersHttpRequest request) Retrieves a list of autoscalers contained within the specified zone.
AutoscalerClient.ListAutoscalersPagedResponse	listAutoscalers(ProjectZoneName zone) Retrieves a list of autoscalers contained within the specified zone.
AutoscalerClient.ListAutoscalersPagedResponse	listAutoscalers(String zone) Retrieves a list of autoscalers contained within the specified zone.
UnaryCallable<ListAutoscalersHttpRequest,AutoscalerList>	listAutoscalersCallable() Retrieves a list of autoscalers contained within the specified zone.
UnaryCallable<ListAutoscalersHttpRequest,AutoscalerClient.ListAutoscalersPagedResponse>	listAutoscalersPagedCallable() Retrieves a list of autoscalers contained within the specified zone.
Operation	patchAutoscaler(PatchAutoscalerHttpRequest request) Updates an autoscaler in the specified project using the data included in the request.
Operation	patchAutoscaler(String autoscaler, ProjectZoneName zone, Autoscaler autoscalerResource, List<String> fieldMask) Updates an autoscaler in the specified project using the data included in the request.
Operation	patchAutoscaler(String autoscaler, String zone, Autoscaler autoscalerResource, List<String> fieldMask) Updates an autoscaler in the specified project using the data included in the request.
UnaryCallable<PatchAutoscalerHttpRequest,Operation>	patchAutoscalerCallable() Updates an autoscaler in the specified project using the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateAutoscaler(String autoscaler, ProjectZoneName zone, Autoscaler autoscalerResource, List<String> fieldMask) Updates an autoscaler in the specified project using the data included in the request.
Operation	updateAutoscaler(String autoscaler, String zone, Autoscaler autoscalerResource, List<String> fieldMask) Updates an autoscaler in the specified project using the data included in the request.
Operation	updateAutoscaler(UpdateAutoscalerHttpRequest request) Updates an autoscaler in the specified project using the data included in the request.
UnaryCallable<UpdateAutoscalerHttpRequest,Operation>	updateAutoscalerCallable() Updates an autoscaler in the specified project using the data included in the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoscalerClient

protected AutoscalerClient(AutoscalerSettings settings)
                    throws IOException

Constructs an instance of AutoscalerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

AutoscalerClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected AutoscalerClient(AutoscalerStub stub)

Method Detail

create

public static final AutoscalerClient create()
                                     throws IOException

Constructs an instance of AutoscalerClient with default settings.

Throws:

IOException

create

public static final AutoscalerClient create(AutoscalerSettings settings)
                                     throws IOException

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

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final AutoscalerClient create(AutoscalerStub stub)

Constructs an instance of AutoscalerClient, using the given stub for making calls. This is for advanced usage - prefer to use AutoscalerSettings}.

getSettings

public final AutoscalerSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public AutoscalerStub getStub()

aggregatedListAutoscalers

@BetaApi
public final AutoscalerClient.AggregatedListAutoscalersPagedResponse aggregatedListAutoscalers(ProjectName project)

Retrieves an aggregated list of autoscalers.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (AutoscalersScopedList element : autoscalerClient.aggregatedListAutoscalers(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

aggregatedListAutoscalers

@BetaApi
public final AutoscalerClient.AggregatedListAutoscalersPagedResponse aggregatedListAutoscalers(String project)

Retrieves an aggregated list of autoscalers.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (AutoscalersScopedList element : autoscalerClient.aggregatedListAutoscalers(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

aggregatedListAutoscalers

@BetaApi
public final AutoscalerClient.AggregatedListAutoscalersPagedResponse aggregatedListAutoscalers(AggregatedListAutoscalersHttpRequest request)

Retrieves an aggregated list of autoscalers.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListAutoscalersHttpRequest request = AggregatedListAutoscalersHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (AutoscalersScopedList element : autoscalerClient.aggregatedListAutoscalers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

aggregatedListAutoscalersPagedCallable

@BetaApi
public final UnaryCallable<AggregatedListAutoscalersHttpRequest,AutoscalerClient.AggregatedListAutoscalersPagedResponse> aggregatedListAutoscalersPagedCallable()

Retrieves an aggregated list of autoscalers.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListAutoscalersHttpRequest request = AggregatedListAutoscalersHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListAutoscalersPagedResponse> future = autoscalerClient.aggregatedListAutoscalersPagedCallable().futureCall(request);
   // Do something
   for (AutoscalersScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListAutoscalersCallable

@BetaApi
public final UnaryCallable<AggregatedListAutoscalersHttpRequest,AutoscalerAggregatedList> aggregatedListAutoscalersCallable()

Retrieves an aggregated list of autoscalers.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListAutoscalersHttpRequest request = AggregatedListAutoscalersHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     AutoscalerAggregatedList response = autoscalerClient.aggregatedListAutoscalersCallable().call(request);
     for (AutoscalersScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteAutoscaler

@BetaApi
public final Operation deleteAutoscaler(ProjectZoneAutoscalerName autoscaler)

Deletes the specified autoscaler.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneAutoscalerName autoscaler = ProjectZoneAutoscalerName.of("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   Operation response = autoscalerClient.deleteAutoscaler(autoscaler);
 }
 

Parameters:

autoscaler - Name of the autoscaler to delete.

Throws:

ApiException - if the remote call fails

deleteAutoscaler

@BetaApi
public final Operation deleteAutoscaler(String autoscaler)

Deletes the specified autoscaler.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneAutoscalerName autoscaler = ProjectZoneAutoscalerName.of("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   Operation response = autoscalerClient.deleteAutoscaler(autoscaler.toString());
 }
 

Parameters:

autoscaler - Name of the autoscaler to delete.

Throws:

ApiException - if the remote call fails

deleteAutoscaler

@BetaApi
public final Operation deleteAutoscaler(DeleteAutoscalerHttpRequest request)

Deletes the specified autoscaler.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedAutoscaler = ProjectZoneAutoscalerName.format("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   DeleteAutoscalerHttpRequest request = DeleteAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(formattedAutoscaler)
     .build();
   Operation response = autoscalerClient.deleteAutoscaler(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteAutoscalerCallable

@BetaApi
public final UnaryCallable<DeleteAutoscalerHttpRequest,Operation> deleteAutoscalerCallable()

Deletes the specified autoscaler.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedAutoscaler = ProjectZoneAutoscalerName.format("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   DeleteAutoscalerHttpRequest request = DeleteAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(formattedAutoscaler)
     .build();
   ApiFuture<Operation> future = autoscalerClient.deleteAutoscalerCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getAutoscaler

@BetaApi
public final Autoscaler getAutoscaler(ProjectZoneAutoscalerName autoscaler)

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneAutoscalerName autoscaler = ProjectZoneAutoscalerName.of("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   Autoscaler response = autoscalerClient.getAutoscaler(autoscaler);
 }
 

Parameters:

autoscaler - Name of the autoscaler to return.

Throws:

ApiException - if the remote call fails

getAutoscaler

@BetaApi
public final Autoscaler getAutoscaler(String autoscaler)

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneAutoscalerName autoscaler = ProjectZoneAutoscalerName.of("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   Autoscaler response = autoscalerClient.getAutoscaler(autoscaler.toString());
 }
 

Parameters:

autoscaler - Name of the autoscaler to return.

Throws:

ApiException - if the remote call fails

getAutoscaler

@BetaApi
public final Autoscaler getAutoscaler(GetAutoscalerHttpRequest request)

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedAutoscaler = ProjectZoneAutoscalerName.format("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   GetAutoscalerHttpRequest request = GetAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(formattedAutoscaler)
     .build();
   Autoscaler response = autoscalerClient.getAutoscaler(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getAutoscalerCallable

@BetaApi
public final UnaryCallable<GetAutoscalerHttpRequest,Autoscaler> getAutoscalerCallable()

Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedAutoscaler = ProjectZoneAutoscalerName.format("[PROJECT]", "[ZONE]", "[AUTOSCALER]");
   GetAutoscalerHttpRequest request = GetAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(formattedAutoscaler)
     .build();
   ApiFuture<Autoscaler> future = autoscalerClient.getAutoscalerCallable().futureCall(request);
   // Do something
   Autoscaler response = future.get();
 }
 

insertAutoscaler

@BetaApi
public final Operation insertAutoscaler(ProjectZoneName zone,
                                                 Autoscaler autoscalerResource)

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response = autoscalerClient.insertAutoscaler(zone, autoscalerResource);
 }
 

Parameters:

zone - Name of the zone for this request.

autoscalerResource - Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Throws:

ApiException - if the remote call fails

insertAutoscaler

@BetaApi
public final Operation insertAutoscaler(String zone,
                                                 Autoscaler autoscalerResource)

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   Operation response = autoscalerClient.insertAutoscaler(zone.toString(), autoscalerResource);
 }
 

Parameters:

zone - Name of the zone for this request.

autoscalerResource - Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

Throws:

ApiException - if the remote call fails

insertAutoscaler

@BetaApi
public final Operation insertAutoscaler(InsertAutoscalerHttpRequest request)

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   InsertAutoscalerHttpRequest request = InsertAutoscalerHttpRequest.newBuilder()
     .setZone(formattedZone)
     .setAutoscalerResource(autoscalerResource)
     .build();
   Operation response = autoscalerClient.insertAutoscaler(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

insertAutoscalerCallable

@BetaApi
public final UnaryCallable<InsertAutoscalerHttpRequest,Operation> insertAutoscalerCallable()

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   InsertAutoscalerHttpRequest request = InsertAutoscalerHttpRequest.newBuilder()
     .setZone(formattedZone)
     .setAutoscalerResource(autoscalerResource)
     .build();
   ApiFuture<Operation> future = autoscalerClient.insertAutoscalerCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listAutoscalers

@BetaApi
public final AutoscalerClient.ListAutoscalersPagedResponse listAutoscalers(ProjectZoneName zone)

Retrieves a list of autoscalers contained within the specified zone.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (Autoscaler element : autoscalerClient.listAutoscalers(zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

zone - Name of the zone for this request.

Throws:

ApiException - if the remote call fails

listAutoscalers

@BetaApi
public final AutoscalerClient.ListAutoscalersPagedResponse listAutoscalers(String zone)

Retrieves a list of autoscalers contained within the specified zone.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (Autoscaler element : autoscalerClient.listAutoscalers(zone.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

zone - Name of the zone for this request.

Throws:

ApiException - if the remote call fails

listAutoscalers

@BetaApi
public final AutoscalerClient.ListAutoscalersPagedResponse listAutoscalers(ListAutoscalersHttpRequest request)

Retrieves a list of autoscalers contained within the specified zone.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListAutoscalersHttpRequest request = ListAutoscalersHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   for (Autoscaler element : autoscalerClient.listAutoscalers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listAutoscalersPagedCallable

@BetaApi
public final UnaryCallable<ListAutoscalersHttpRequest,AutoscalerClient.ListAutoscalersPagedResponse> listAutoscalersPagedCallable()

Retrieves a list of autoscalers contained within the specified zone.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListAutoscalersHttpRequest request = ListAutoscalersHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   ApiFuture<ListAutoscalersPagedResponse> future = autoscalerClient.listAutoscalersPagedCallable().futureCall(request);
   // Do something
   for (Autoscaler element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listAutoscalersCallable

@BetaApi
public final UnaryCallable<ListAutoscalersHttpRequest,AutoscalerList> listAutoscalersCallable()

Retrieves a list of autoscalers contained within the specified zone.

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListAutoscalersHttpRequest request = ListAutoscalersHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   while (true) {
     AutoscalerList response = autoscalerClient.listAutoscalersCallable().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;
     }
   }
 }
 

patchAutoscaler

@BetaApi
public final Operation patchAutoscaler(String autoscaler,
                                                ProjectZoneName zone,
                                                Autoscaler autoscalerResource,
                                                List<String> fieldMask)

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:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = autoscalerClient.patchAutoscaler(autoscaler, zone, autoscalerResource, fieldMask);
 }
 

Parameters:

autoscaler - Name of the autoscaler to patch.

zone - Name of the zone for this request.

autoscalerResource - Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

patchAutoscaler

@BetaApi
public final Operation patchAutoscaler(String autoscaler,
                                                String zone,
                                                Autoscaler autoscalerResource,
                                                List<String> fieldMask)

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:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = autoscalerClient.patchAutoscaler(autoscaler, zone.toString(), autoscalerResource, fieldMask);
 }
 

Parameters:

autoscaler - Name of the autoscaler to patch.

zone - Name of the zone for this request.

autoscalerResource - Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

patchAutoscaler

@BetaApi
public final Operation patchAutoscaler(PatchAutoscalerHttpRequest 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:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchAutoscalerHttpRequest request = PatchAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(autoscaler)
     .setZone(formattedZone)
     .setAutoscalerResource(autoscalerResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = autoscalerClient.patchAutoscaler(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

patchAutoscalerCallable

@BetaApi
public final UnaryCallable<PatchAutoscalerHttpRequest,Operation> patchAutoscalerCallable()

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:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchAutoscalerHttpRequest request = PatchAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(autoscaler)
     .setZone(formattedZone)
     .setAutoscalerResource(autoscalerResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = autoscalerClient.patchAutoscalerCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateAutoscaler

@BetaApi
public final Operation updateAutoscaler(String autoscaler,
                                                 ProjectZoneName zone,
                                                 Autoscaler autoscalerResource,
                                                 List<String> fieldMask)

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = autoscalerClient.updateAutoscaler(autoscaler, zone, autoscalerResource, fieldMask);
 }
 

Parameters:

autoscaler - Name of the autoscaler to update.

zone - Name of the zone for this request.

autoscalerResource - Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

updateAutoscaler

@BetaApi
public final Operation updateAutoscaler(String autoscaler,
                                                 String zone,
                                                 Autoscaler autoscalerResource,
                                                 List<String> fieldMask)

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = autoscalerClient.updateAutoscaler(autoscaler, zone.toString(), autoscalerResource, fieldMask);
 }
 

Parameters:

autoscaler - Name of the autoscaler to update.

zone - Name of the zone for this request.

autoscalerResource - Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

updateAutoscaler

@BetaApi
public final Operation updateAutoscaler(UpdateAutoscalerHttpRequest request)

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateAutoscalerHttpRequest request = UpdateAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(autoscaler)
     .setZone(formattedZone)
     .setAutoscalerResource(autoscalerResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = autoscalerClient.updateAutoscaler(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

updateAutoscalerCallable

@BetaApi
public final UnaryCallable<UpdateAutoscalerHttpRequest,Operation> updateAutoscalerCallable()

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

Sample code:

 try (AutoscalerClient autoscalerClient = AutoscalerClient.create()) {
   String autoscaler = "";
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateAutoscalerHttpRequest request = UpdateAutoscalerHttpRequest.newBuilder()
     .setAutoscaler(autoscaler)
     .setZone(formattedZone)
     .setAutoscalerResource(autoscalerResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = autoscalerClient.updateAutoscalerCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException