- 1.57.0 (latest)
- 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 InstanceGroupsClient implements BackgroundResource
Service Description: The InstanceGroups 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 (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String instanceGroup = "instanceGroup-1404696854";
InstanceGroup response = instanceGroupsClient.get(project, zone, instanceGroup);
}
Note: close() needs to be called on the InstanceGroupsClient 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 InstanceGroupsSettings to create(). For example:
To customize credentials:
InstanceGroupsSettings instanceGroupsSettings =
InstanceGroupsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create(instanceGroupsSettings);
To customize the endpoint:
InstanceGroupsSettings instanceGroupsSettings =
InstanceGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create(instanceGroupsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final InstanceGroupsClient create()
Constructs an instance of InstanceGroupsClient with default settings.
Type | Description |
InstanceGroupsClient |
Type | Description |
IOException |
create(InstanceGroupsSettings settings)
public static final InstanceGroupsClient create(InstanceGroupsSettings settings)
Constructs an instance of InstanceGroupsClient, 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 | InstanceGroupsSettings |
Type | Description |
InstanceGroupsClient |
Type | Description |
IOException |
create(InstanceGroupsStub stub)
public static final InstanceGroupsClient create(InstanceGroupsStub stub)
Constructs an instance of InstanceGroupsClient, using the given stub for making calls. This is for advanced usage - prefer using create(InstanceGroupsSettings).
Name | Description |
stub | InstanceGroupsStub |
Type | Description |
InstanceGroupsClient |
Constructors
InstanceGroupsClient(InstanceGroupsSettings settings)
protected InstanceGroupsClient(InstanceGroupsSettings settings)
Constructs an instance of InstanceGroupsClient, 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 | InstanceGroupsSettings |
InstanceGroupsClient(InstanceGroupsStub stub)
protected InstanceGroupsClient(InstanceGroupsStub stub)
Name | Description |
stub | InstanceGroupsStub |
Methods
addInstancesAsync(AddInstancesInstanceGroupRequest request)
public final OperationFuture<Operation,Operation> addInstancesAsync(AddInstancesInstanceGroupRequest request)
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
AddInstancesInstanceGroupRequest request =
AddInstancesInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsAddInstancesRequestResource(
InstanceGroupsAddInstancesRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
Operation response = instanceGroupsClient.addInstancesAsync(request).get();
}
Name | Description |
request | AddInstancesInstanceGroupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
addInstancesAsync(String project, String zone, String instanceGroup, InstanceGroupsAddInstancesRequest instanceGroupsAddInstancesRequestResource)
public final OperationFuture<Operation,Operation> addInstancesAsync(String project, String zone, String instanceGroup, InstanceGroupsAddInstancesRequest instanceGroupsAddInstancesRequestResource)
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String instanceGroup = "instanceGroup-1404696854";
InstanceGroupsAddInstancesRequest instanceGroupsAddInstancesRequestResource =
InstanceGroupsAddInstancesRequest.newBuilder().build();
Operation response =
instanceGroupsClient
.addInstancesAsync(
project, zone, instanceGroup, instanceGroupsAddInstancesRequestResource)
.get();
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where the instance group is located. |
instanceGroup | String The name of the instance group where you are adding instances. |
instanceGroupsAddInstancesRequestResource | InstanceGroupsAddInstancesRequest The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
addInstancesCallable()
public final UnaryCallable<AddInstancesInstanceGroupRequest,Operation> addInstancesCallable()
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
AddInstancesInstanceGroupRequest request =
AddInstancesInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsAddInstancesRequestResource(
InstanceGroupsAddInstancesRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture<Operation> future = instanceGroupsClient.addInstancesCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<AddInstancesInstanceGroupRequest,Operation> |
addInstancesOperationCallable()
public final OperationCallable<AddInstancesInstanceGroupRequest,Operation,Operation> addInstancesOperationCallable()
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
AddInstancesInstanceGroupRequest request =
AddInstancesInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsAddInstancesRequestResource(
InstanceGroupsAddInstancesRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture<Operation, Operation> future =
instanceGroupsClient.addInstancesOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<AddInstancesInstanceGroupRequest,Operation,Operation> |
aggregatedList(AggregatedListInstanceGroupsRequest request)
public final InstanceGroupsClient.AggregatedListPagedResponse aggregatedList(AggregatedListInstanceGroupsRequest request)
Retrieves the list of instance groups and sorts them by zone.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
AggregatedListInstanceGroupsRequest request =
AggregatedListInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
for (Map.Entry<String, InstanceGroupsScopedList> element :
instanceGroupsClient.aggregatedList(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | AggregatedListInstanceGroupsRequest The request object containing all of the parameters for the API call. |
Type | Description |
InstanceGroupsClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final InstanceGroupsClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves the list of instance groups and sorts them by zone.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
for (Map.Entry<String, InstanceGroupsScopedList> element :
instanceGroupsClient.aggregatedList(project).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
Type | Description |
InstanceGroupsClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListInstanceGroupsRequest,InstanceGroupAggregatedList> aggregatedListCallable()
Retrieves the list of instance groups and sorts them by zone.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
AggregatedListInstanceGroupsRequest request =
AggregatedListInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
while (true) {
InstanceGroupAggregatedList response =
instanceGroupsClient.aggregatedListCallable().call(request);
for (Map.Entry<String, InstanceGroupsScopedList> element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<AggregatedListInstanceGroupsRequest,InstanceGroupAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListInstanceGroupsRequest,InstanceGroupsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves the list of instance groups and sorts them by zone.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
AggregatedListInstanceGroupsRequest request =
AggregatedListInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
ApiFuture<Map.Entry<String, InstanceGroupsScopedList>> future =
instanceGroupsClient.aggregatedListPagedCallable().futureCall(request);
// Do something.
for (Map.Entry<String, InstanceGroupsScopedList> element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<AggregatedListInstanceGroupsRequest,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()
deleteAsync(DeleteInstanceGroupRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteInstanceGroupRequest request)
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
DeleteInstanceGroupRequest request =
DeleteInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
Operation response = instanceGroupsClient.deleteAsync(request).get();
}
Name | Description |
request | DeleteInstanceGroupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String zone, String instanceGroup)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String zone, String instanceGroup)
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String instanceGroup = "instanceGroup-1404696854";
Operation response = instanceGroupsClient.deleteAsync(project, zone, instanceGroup).get();
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where the instance group is located. |
instanceGroup | String The name of the instance group to delete. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteInstanceGroupRequest,Operation> deleteCallable()
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
DeleteInstanceGroupRequest request =
DeleteInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture<Operation> future = instanceGroupsClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<DeleteInstanceGroupRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteInstanceGroupRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
DeleteInstanceGroupRequest request =
DeleteInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture<Operation, Operation> future =
instanceGroupsClient.deleteOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<DeleteInstanceGroupRequest,Operation,Operation> |
get(GetInstanceGroupRequest request)
public final InstanceGroup get(GetInstanceGroupRequest request)
Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
GetInstanceGroupRequest request =
GetInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
InstanceGroup response = instanceGroupsClient.get(request);
}
Name | Description |
request | GetInstanceGroupRequest The request object containing all of the parameters for the API call. |
Type | Description |
InstanceGroup |
get(String project, String zone, String instanceGroup)
public final InstanceGroup get(String project, String zone, String instanceGroup)
Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String instanceGroup = "instanceGroup-1404696854";
InstanceGroup response = instanceGroupsClient.get(project, zone, instanceGroup);
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where the instance group is located. |
instanceGroup | String The name of the instance group. |
Type | Description |
InstanceGroup |
getCallable()
public final UnaryCallable<GetInstanceGroupRequest,InstanceGroup> getCallable()
Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
GetInstanceGroupRequest request =
GetInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
ApiFuture<InstanceGroup> future = instanceGroupsClient.getCallable().futureCall(request);
// Do something.
InstanceGroup response = future.get();
}
Type | Description |
UnaryCallable<GetInstanceGroupRequest,InstanceGroup> |
getSettings()
public final InstanceGroupsSettings getSettings()
Type | Description |
InstanceGroupsSettings |
getStub()
public InstanceGroupsStub getStub()
Type | Description |
InstanceGroupsStub |
insertAsync(InsertInstanceGroupRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertInstanceGroupRequest request)
Creates an instance group in the specified project using the parameters that are included in the request.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
InsertInstanceGroupRequest request =
InsertInstanceGroupRequest.newBuilder()
.setInstanceGroupResource(InstanceGroup.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
Operation response = instanceGroupsClient.insertAsync(request).get();
}
Name | Description |
request | InsertInstanceGroupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, String zone, InstanceGroup instanceGroupResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, String zone, InstanceGroup instanceGroupResource)
Creates an instance group in the specified project using the parameters that are included in the request.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
InstanceGroup instanceGroupResource = InstanceGroup.newBuilder().build();
Operation response =
instanceGroupsClient.insertAsync(project, zone, instanceGroupResource).get();
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where you want to create the instance group. |
instanceGroupResource | InstanceGroup The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertInstanceGroupRequest,Operation> insertCallable()
Creates an instance group in the specified project using the parameters that are included in the request.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
InsertInstanceGroupRequest request =
InsertInstanceGroupRequest.newBuilder()
.setInstanceGroupResource(InstanceGroup.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture<Operation> future = instanceGroupsClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<InsertInstanceGroupRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertInstanceGroupRequest,Operation,Operation> insertOperationCallable()
Creates an instance group in the specified project using the parameters that are included in the request.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
InsertInstanceGroupRequest request =
InsertInstanceGroupRequest.newBuilder()
.setInstanceGroupResource(InstanceGroup.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture<Operation, Operation> future =
instanceGroupsClient.insertOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<InsertInstanceGroupRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
list(ListInstanceGroupsRequest request)
public final InstanceGroupsClient.ListPagedResponse list(ListInstanceGroupsRequest request)
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
ListInstanceGroupsRequest request =
ListInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
for (InstanceGroup element : instanceGroupsClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListInstanceGroupsRequest The request object containing all of the parameters for the API call. |
Type | Description |
InstanceGroupsClient.ListPagedResponse |
list(String project, String zone)
public final InstanceGroupsClient.ListPagedResponse list(String project, String zone)
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
for (InstanceGroup element : instanceGroupsClient.list(project, zone).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where the instance group is located. |
Type | Description |
InstanceGroupsClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListInstanceGroupsRequest,InstanceGroupList> listCallable()
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
ListInstanceGroupsRequest request =
ListInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
while (true) {
InstanceGroupList response = instanceGroupsClient.listCallable().call(request);
for (InstanceGroup element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListInstanceGroupsRequest,InstanceGroupList> |
listInstances(ListInstancesInstanceGroupsRequest request)
public final InstanceGroupsClient.ListInstancesPagedResponse listInstances(ListInstancesInstanceGroupsRequest request)
Lists the instances in the specified instance group. The orderBy query parameter is not supported.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
ListInstancesInstanceGroupsRequest request =
ListInstancesInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsListInstancesRequestResource(
InstanceGroupsListInstancesRequest.newBuilder().build())
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
for (InstanceWithNamedPorts element :
instanceGroupsClient.listInstances(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListInstancesInstanceGroupsRequest The request object containing all of the parameters for the API call. |
Type | Description |
InstanceGroupsClient.ListInstancesPagedResponse |
listInstances(String project, String zone, String instanceGroup, InstanceGroupsListInstancesRequest instanceGroupsListInstancesRequestResource)
public final InstanceGroupsClient.ListInstancesPagedResponse listInstances(String project, String zone, String instanceGroup, InstanceGroupsListInstancesRequest instanceGroupsListInstancesRequestResource)
Lists the instances in the specified instance group. The orderBy query parameter is not supported.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String instanceGroup = "instanceGroup-1404696854";
InstanceGroupsListInstancesRequest instanceGroupsListInstancesRequestResource =
InstanceGroupsListInstancesRequest.newBuilder().build();
for (InstanceWithNamedPorts element :
instanceGroupsClient
.listInstances(
project, zone, instanceGroup, instanceGroupsListInstancesRequestResource)
.iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where the instance group is located. |
instanceGroup | String The name of the instance group from which you want to generate a list of included instances. |
instanceGroupsListInstancesRequestResource | InstanceGroupsListInstancesRequest The body resource for this request |
Type | Description |
InstanceGroupsClient.ListInstancesPagedResponse |
listInstancesCallable()
public final UnaryCallable<ListInstancesInstanceGroupsRequest,InstanceGroupsListInstances> listInstancesCallable()
Lists the instances in the specified instance group. The orderBy query parameter is not supported.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
ListInstancesInstanceGroupsRequest request =
ListInstancesInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsListInstancesRequestResource(
InstanceGroupsListInstancesRequest.newBuilder().build())
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
while (true) {
InstanceGroupsListInstances response =
instanceGroupsClient.listInstancesCallable().call(request);
for (InstanceWithNamedPorts element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListInstancesInstanceGroupsRequest,InstanceGroupsListInstances> |
listInstancesPagedCallable()
public final UnaryCallable<ListInstancesInstanceGroupsRequest,InstanceGroupsClient.ListInstancesPagedResponse> listInstancesPagedCallable()
Lists the instances in the specified instance group. The orderBy query parameter is not supported.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
ListInstancesInstanceGroupsRequest request =
ListInstancesInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsListInstancesRequestResource(
InstanceGroupsListInstancesRequest.newBuilder().build())
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
ApiFuture<InstanceWithNamedPorts> future =
instanceGroupsClient.listInstancesPagedCallable().futureCall(request);
// Do something.
for (InstanceWithNamedPorts element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListInstancesInstanceGroupsRequest,ListInstancesPagedResponse> |
listPagedCallable()
public final UnaryCallable<ListInstanceGroupsRequest,InstanceGroupsClient.ListPagedResponse> listPagedCallable()
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
ListInstanceGroupsRequest request =
ListInstanceGroupsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
ApiFuture<InstanceGroup> future =
instanceGroupsClient.listPagedCallable().futureCall(request);
// Do something.
for (InstanceGroup element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListInstanceGroupsRequest,ListPagedResponse> |
removeInstancesAsync(RemoveInstancesInstanceGroupRequest request)
public final OperationFuture<Operation,Operation> removeInstancesAsync(RemoveInstancesInstanceGroupRequest request)
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
RemoveInstancesInstanceGroupRequest request =
RemoveInstancesInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsRemoveInstancesRequestResource(
InstanceGroupsRemoveInstancesRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
Operation response = instanceGroupsClient.removeInstancesAsync(request).get();
}
Name | Description |
request | RemoveInstancesInstanceGroupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
removeInstancesAsync(String project, String zone, String instanceGroup, InstanceGroupsRemoveInstancesRequest instanceGroupsRemoveInstancesRequestResource)
public final OperationFuture<Operation,Operation> removeInstancesAsync(String project, String zone, String instanceGroup, InstanceGroupsRemoveInstancesRequest instanceGroupsRemoveInstancesRequestResource)
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String instanceGroup = "instanceGroup-1404696854";
InstanceGroupsRemoveInstancesRequest instanceGroupsRemoveInstancesRequestResource =
InstanceGroupsRemoveInstancesRequest.newBuilder().build();
Operation response =
instanceGroupsClient
.removeInstancesAsync(
project, zone, instanceGroup, instanceGroupsRemoveInstancesRequestResource)
.get();
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where the instance group is located. |
instanceGroup | String The name of the instance group where the specified instances will be removed. |
instanceGroupsRemoveInstancesRequestResource | InstanceGroupsRemoveInstancesRequest The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
removeInstancesCallable()
public final UnaryCallable<RemoveInstancesInstanceGroupRequest,Operation> removeInstancesCallable()
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
RemoveInstancesInstanceGroupRequest request =
RemoveInstancesInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsRemoveInstancesRequestResource(
InstanceGroupsRemoveInstancesRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture<Operation> future =
instanceGroupsClient.removeInstancesCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<RemoveInstancesInstanceGroupRequest,Operation> |
removeInstancesOperationCallable()
public final OperationCallable<RemoveInstancesInstanceGroupRequest,Operation,Operation> removeInstancesOperationCallable()
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
RemoveInstancesInstanceGroupRequest request =
RemoveInstancesInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsRemoveInstancesRequestResource(
InstanceGroupsRemoveInstancesRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture<Operation, Operation> future =
instanceGroupsClient.removeInstancesOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<RemoveInstancesInstanceGroupRequest,Operation,Operation> |
setNamedPortsAsync(SetNamedPortsInstanceGroupRequest request)
public final OperationFuture<Operation,Operation> setNamedPortsAsync(SetNamedPortsInstanceGroupRequest request)
Sets the named ports for the specified instance group.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
SetNamedPortsInstanceGroupRequest request =
SetNamedPortsInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsSetNamedPortsRequestResource(
InstanceGroupsSetNamedPortsRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
Operation response = instanceGroupsClient.setNamedPortsAsync(request).get();
}
Name | Description |
request | SetNamedPortsInstanceGroupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
setNamedPortsAsync(String project, String zone, String instanceGroup, InstanceGroupsSetNamedPortsRequest instanceGroupsSetNamedPortsRequestResource)
public final OperationFuture<Operation,Operation> setNamedPortsAsync(String project, String zone, String instanceGroup, InstanceGroupsSetNamedPortsRequest instanceGroupsSetNamedPortsRequestResource)
Sets the named ports for the specified instance group.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String instanceGroup = "instanceGroup-1404696854";
InstanceGroupsSetNamedPortsRequest instanceGroupsSetNamedPortsRequestResource =
InstanceGroupsSetNamedPortsRequest.newBuilder().build();
Operation response =
instanceGroupsClient
.setNamedPortsAsync(
project, zone, instanceGroup, instanceGroupsSetNamedPortsRequestResource)
.get();
}
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone where the instance group is located. |
instanceGroup | String The name of the instance group where the named ports are updated. |
instanceGroupsSetNamedPortsRequestResource | InstanceGroupsSetNamedPortsRequest The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
setNamedPortsCallable()
public final UnaryCallable<SetNamedPortsInstanceGroupRequest,Operation> setNamedPortsCallable()
Sets the named ports for the specified instance group.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
SetNamedPortsInstanceGroupRequest request =
SetNamedPortsInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsSetNamedPortsRequestResource(
InstanceGroupsSetNamedPortsRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
ApiFuture<Operation> future =
instanceGroupsClient.setNamedPortsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<SetNamedPortsInstanceGroupRequest,Operation> |
setNamedPortsOperationCallable()
public final OperationCallable<SetNamedPortsInstanceGroupRequest,Operation,Operation> setNamedPortsOperationCallable()
Sets the named ports for the specified instance group.
Sample code:
try (InstanceGroupsClient instanceGroupsClient = InstanceGroupsClient.create()) {
SetNamedPortsInstanceGroupRequest request =
SetNamedPortsInstanceGroupRequest.newBuilder()
.setInstanceGroup("instanceGroup-1404696854")
.setInstanceGroupsSetNamedPortsRequestResource(
InstanceGroupsSetNamedPortsRequest.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
OperationFuture<Operation, Operation> future =
instanceGroupsClient.setNamedPortsOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<SetNamedPortsInstanceGroupRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()