- 1.62.0 (latest)
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class RegionAutoscalersClient implements BackgroundResource
Service Description: The RegionAutoscalers API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String autoscaler = "autoscaler517258967";
Autoscaler response = regionAutoscalersClient.get(project, region, autoscaler);
}
Note: close() needs to be called on the RegionAutoscalersClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
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 RegionAutoscalersSettings to create(). For example:
To customize credentials:
RegionAutoscalersSettings regionAutoscalersSettings =
RegionAutoscalersSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RegionAutoscalersClient regionAutoscalersClient =
RegionAutoscalersClient.create(regionAutoscalersSettings);
To customize the endpoint:
RegionAutoscalersSettings regionAutoscalersSettings =
RegionAutoscalersSettings.newBuilder().setEndpoint(myEndpoint).build();
RegionAutoscalersClient regionAutoscalersClient =
RegionAutoscalersClient.create(regionAutoscalersSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final RegionAutoscalersClient create()
Constructs an instance of RegionAutoscalersClient with default settings.
Type | Description |
RegionAutoscalersClient |
Type | Description |
IOException |
create(RegionAutoscalersSettings settings)
public static final RegionAutoscalersClient create(RegionAutoscalersSettings settings)
Constructs an instance of RegionAutoscalersClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | RegionAutoscalersSettings |
Type | Description |
RegionAutoscalersClient |
Type | Description |
IOException |
create(RegionAutoscalersStub stub)
public static final RegionAutoscalersClient create(RegionAutoscalersStub stub)
Constructs an instance of RegionAutoscalersClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionAutoscalersSettings).
Name | Description |
stub | RegionAutoscalersStub |
Type | Description |
RegionAutoscalersClient |
Constructors
RegionAutoscalersClient(RegionAutoscalersSettings settings)
protected RegionAutoscalersClient(RegionAutoscalersSettings settings)
Constructs an instance of RegionAutoscalersClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Name | Description |
settings | RegionAutoscalersSettings |
RegionAutoscalersClient(RegionAutoscalersStub stub)
protected RegionAutoscalersClient(RegionAutoscalersStub stub)
Name | Description |
stub | RegionAutoscalersStub |
Methods
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()
deleteAsync(DeleteRegionAutoscalerRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionAutoscalerRequest request)
Deletes the specified autoscaler.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
DeleteRegionAutoscalerRequest request =
DeleteRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionAutoscalersClient.deleteAsync(request).get();
}
Name | Description |
request | DeleteRegionAutoscalerRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String region, String autoscaler)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String autoscaler)
Deletes the specified autoscaler.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String autoscaler = "autoscaler517258967";
Operation response = regionAutoscalersClient.deleteAsync(project, region, autoscaler).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
autoscaler | String Name of the autoscaler to delete. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteRegionAutoscalerRequest,Operation> deleteCallable()
Deletes the specified autoscaler.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
DeleteRegionAutoscalerRequest request =
DeleteRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = regionAutoscalersClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<DeleteRegionAutoscalerRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteRegionAutoscalerRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified autoscaler.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
DeleteRegionAutoscalerRequest request =
DeleteRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture
Type | Description |
OperationCallable<DeleteRegionAutoscalerRequest,Operation,Operation> |
get(GetRegionAutoscalerRequest request)
public final Autoscaler get(GetRegionAutoscalerRequest request)
Returns the specified autoscaler.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
GetRegionAutoscalerRequest request =
GetRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
Autoscaler response = regionAutoscalersClient.get(request);
}
Name | Description |
request | GetRegionAutoscalerRequest The request object containing all of the parameters for the API call. |
Type | Description |
Autoscaler |
get(String project, String region, String autoscaler)
public final Autoscaler get(String project, String region, String autoscaler)
Returns the specified autoscaler.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String autoscaler = "autoscaler517258967";
Autoscaler response = regionAutoscalersClient.get(project, region, autoscaler);
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
autoscaler | String Name of the autoscaler to return. |
Type | Description |
Autoscaler |
getCallable()
public final UnaryCallable<GetRegionAutoscalerRequest,Autoscaler> getCallable()
Returns the specified autoscaler.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
GetRegionAutoscalerRequest request =
GetRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
ApiFuture<Autoscaler> future = regionAutoscalersClient.getCallable().futureCall(request);
// Do something.
Autoscaler response = future.get();
}
Type | Description |
UnaryCallable<GetRegionAutoscalerRequest,Autoscaler> |
getSettings()
public final RegionAutoscalersSettings getSettings()
Type | Description |
RegionAutoscalersSettings |
getStub()
public RegionAutoscalersStub getStub()
Type | Description |
RegionAutoscalersStub |
insertAsync(InsertRegionAutoscalerRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertRegionAutoscalerRequest request)
Creates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
InsertRegionAutoscalerRequest request =
InsertRegionAutoscalerRequest.newBuilder()
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionAutoscalersClient.insertAsync(request).get();
}
Name | Description |
request | InsertRegionAutoscalerRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, String region, Autoscaler autoscalerResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, String region, Autoscaler autoscalerResource)
Creates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
Operation response =
regionAutoscalersClient.insertAsync(project, region, autoscalerResource).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
autoscalerResource | Autoscaler The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertRegionAutoscalerRequest,Operation> insertCallable()
Creates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
InsertRegionAutoscalerRequest request =
InsertRegionAutoscalerRequest.newBuilder()
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = regionAutoscalersClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<InsertRegionAutoscalerRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertRegionAutoscalerRequest,Operation,Operation> insertOperationCallable()
Creates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
InsertRegionAutoscalerRequest request =
InsertRegionAutoscalerRequest.newBuilder()
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture
Type | Description |
OperationCallable<InsertRegionAutoscalerRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
list(ListRegionAutoscalersRequest request)
public final RegionAutoscalersClient.ListPagedResponse list(ListRegionAutoscalersRequest request)
Retrieves a list of autoscalers contained within the specified region.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
ListRegionAutoscalersRequest request =
ListRegionAutoscalersRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
for (Autoscaler element : regionAutoscalersClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListRegionAutoscalersRequest The request object containing all of the parameters for the API call. |
Type | Description |
RegionAutoscalersClient.ListPagedResponse |
list(String project, String region)
public final RegionAutoscalersClient.ListPagedResponse list(String project, String region)
Retrieves a list of autoscalers contained within the specified region.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
for (Autoscaler element : regionAutoscalersClient.list(project, region).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
Type | Description |
RegionAutoscalersClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListRegionAutoscalersRequest,RegionAutoscalerList> listCallable()
Retrieves a list of autoscalers contained within the specified region.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
ListRegionAutoscalersRequest request =
ListRegionAutoscalersRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
while (true) {
RegionAutoscalerList response = regionAutoscalersClient.listCallable().call(request);
for (Autoscaler element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListRegionAutoscalersRequest,RegionAutoscalerList> |
listPagedCallable()
public final UnaryCallable<ListRegionAutoscalersRequest,RegionAutoscalersClient.ListPagedResponse> listPagedCallable()
Retrieves a list of autoscalers contained within the specified region.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
ListRegionAutoscalersRequest request =
ListRegionAutoscalersRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
ApiFuture<Autoscaler> future =
regionAutoscalersClient.listPagedCallable().futureCall(request);
// Do something.
for (Autoscaler element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListRegionAutoscalersRequest,ListPagedResponse> |
patchAsync(PatchRegionAutoscalerRequest request)
public final OperationFuture<Operation,Operation> patchAsync(PatchRegionAutoscalerRequest 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 (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
PatchRegionAutoscalerRequest request =
PatchRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionAutoscalersClient.patchAsync(request).get();
}
Name | Description |
request | PatchRegionAutoscalerRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
patchAsync(String project, String region, Autoscaler autoscalerResource)
public final OperationFuture<Operation,Operation> patchAsync(String project, String region, Autoscaler autoscalerResource)
Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
Operation response =
regionAutoscalersClient.patchAsync(project, region, autoscalerResource).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
autoscalerResource | Autoscaler The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
patchCallable()
public final UnaryCallable<PatchRegionAutoscalerRequest,Operation> patchCallable()
Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
PatchRegionAutoscalerRequest request =
PatchRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = regionAutoscalersClient.patchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<PatchRegionAutoscalerRequest,Operation> |
patchOperationCallable()
public final OperationCallable<PatchRegionAutoscalerRequest,Operation,Operation> patchOperationCallable()
Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
PatchRegionAutoscalerRequest request =
PatchRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture
Type | Description |
OperationCallable<PatchRegionAutoscalerRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateAsync(UpdateRegionAutoscalerRequest request)
public final OperationFuture<Operation,Operation> updateAsync(UpdateRegionAutoscalerRequest request)
Updates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
UpdateRegionAutoscalerRequest request =
UpdateRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionAutoscalersClient.updateAsync(request).get();
}
Name | Description |
request | UpdateRegionAutoscalerRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
updateAsync(String project, String region, Autoscaler autoscalerResource)
public final OperationFuture<Operation,Operation> updateAsync(String project, String region, Autoscaler autoscalerResource)
Updates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
Autoscaler autoscalerResource = Autoscaler.newBuilder().build();
Operation response =
regionAutoscalersClient.updateAsync(project, region, autoscalerResource).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
autoscalerResource | Autoscaler The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
updateCallable()
public final UnaryCallable<UpdateRegionAutoscalerRequest,Operation> updateCallable()
Updates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
UpdateRegionAutoscalerRequest request =
UpdateRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = regionAutoscalersClient.updateCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<UpdateRegionAutoscalerRequest,Operation> |
updateOperationCallable()
public final OperationCallable<UpdateRegionAutoscalerRequest,Operation,Operation> updateOperationCallable()
Updates an autoscaler in the specified project using the data included in the request.
Sample code:
try (RegionAutoscalersClient regionAutoscalersClient = RegionAutoscalersClient.create()) {
UpdateRegionAutoscalerRequest request =
UpdateRegionAutoscalerRequest.newBuilder()
.setAutoscaler("autoscaler517258967")
.setAutoscalerResource(Autoscaler.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture
Type | Description |
OperationCallable<UpdateRegionAutoscalerRequest,Operation,Operation> |