- 1.63.0 (latest)
- 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:
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:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AutoscalersSettings to create(). For example:
To customize credentials:
AutoscalersSettings autoscalersSettings =
AutoscalersSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AutoscalersClient autoscalersClient = AutoscalersClient.create(autoscalersSettings);
To customize the endpoint:
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.
Implements
BackgroundResourceConstructors
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.
Name | Description |
settings | AutoscalersSettings |
AutoscalersClient(AutoscalersStub stub)
protected AutoscalersClient(AutoscalersStub stub)
Name | Description |
stub | AutoscalersStub |
Methods
aggregatedList(AggregatedListAutoscalersRequest request)
public final AutoscalersClient.AggregatedListPagedResponse aggregatedList(AggregatedListAutoscalersRequest request)
Retrieves an aggregated list of autoscalers.
Sample code:
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
Name | Description |
request | AggregatedListAutoscalersRequest The request object containing all of the parameters for the API call. |
Type | Description |
AutoscalersClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final AutoscalersClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves an aggregated list of autoscalers.
Sample code:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
String project = "project-309310695";
for (Map.Entry
Name | Description |
project | String Project ID for this request. |
Type | Description |
AutoscalersClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListAutoscalersRequest,AutoscalerAggregatedList> aggregatedListCallable()
Retrieves an aggregated list of autoscalers.
Sample code:
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
Type | Description |
UnaryCallable<AggregatedListAutoscalersRequest,AutoscalerAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListAutoscalersRequest,AutoscalersClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves an aggregated list of autoscalers.
Sample code:
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<>
Type | Description |
UnaryCallable<AggregatedListAutoscalersRequest,AggregatedListPagedResponse> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
create()
public static final AutoscalersClient create()
Constructs an instance of AutoscalersClient with default settings.
Type | Description |
AutoscalersClient |
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.
Name | Description |
settings | AutoscalersSettings |
Type | Description |
AutoscalersClient |
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).
Name | Description |
stub | AutoscalersStub |
Type | Description |
AutoscalersClient |
deleteAsync(DeleteAutoscalerRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteAutoscalerRequest request)
Deletes the specified autoscaler.
Sample code:
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();
}
Name | Description |
request | DeleteAutoscalerRequest The request object containing all of the parameters for the API call. |
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String autoscaler = "autoscaler517258967";
Operation response = autoscalersClient.deleteAsync(project, zone, autoscaler).get();
}
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. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteAutoscalerRequest,Operation> deleteCallable()
Deletes the specified autoscaler.
Sample code:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
DeleteAutoscalerRequest request =
DeleteAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture
Type | Description |
UnaryCallable<DeleteAutoscalerRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteAutoscalerRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified autoscaler.
Sample code:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
DeleteAutoscalerRequest request =
DeleteAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
GetAutoscalerRequest request =
GetAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
Autoscaler response = autoscalersClient.get(request);
}
Name | Description |
request | GetAutoscalerRequest The request object containing all of the parameters for the API call. |
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String autoscaler = "autoscaler517258967";
Autoscaler response = autoscalersClient.get(project, zone, autoscaler);
}
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. |
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
GetAutoscalerRequest request =
GetAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
ApiFuture
Type | Description |
UnaryCallable<GetAutoscalerRequest,Autoscaler> |
getSettings()
public final AutoscalersSettings getSettings()
Type | Description |
AutoscalersSettings |
getStub()
public AutoscalersStub getStub()
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:
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();
}
Name | Description |
request | InsertAutoscalerRequest The request object containing all of the parameters for the API call. |
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:
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();
}
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 |
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
InsertAutoscalerRequest request =
InsertAutoscalerRequest.newBuilder()
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
InsertAutoscalerRequest request =
InsertAutoscalerRequest.newBuilder()
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture
Type | Description |
OperationCallable<InsertAutoscalerRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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:
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);
}
}
Name | Description |
request | ListAutoscalersRequest The request object containing all of the parameters for the API call. |
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
for (Autoscaler element : autoscalersClient.list(project, zone).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone for this request. |
Type | Description |
AutoscalersClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListAutoscalersRequest,AutoscalerList> listCallable()
Retrieves a list of autoscalers contained within the specified zone.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
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:
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
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:
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();
}
Name | Description |
request | PatchAutoscalerRequest The request object containing all of the parameters for the API call. |
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:
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();
}
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 |
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
PatchAutoscalerRequest request =
PatchAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
PatchAutoscalerRequest request =
PatchAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture
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:
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();
}
Name | Description |
request | UpdateAutoscalerRequest The request object containing all of the parameters for the API call. |
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:
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();
}
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 |
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
UpdateAutoscalerRequest request =
UpdateAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture
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:
try (AutoscalersClient autoscalersClient = AutoscalersClient.create()) {
UpdateAutoscalerRequest request =
UpdateAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture
Type | Description |
OperationCallable<UpdateAutoscalerRequest,Operation,Operation> |