Class InstanceGroupManagersClient
- java.lang.Object
-
- com.google.cloud.compute.v1.InstanceGroupManagersClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class InstanceGroupManagersClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The InstanceGroupManagers API.This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManager response = instanceGroupManagersClient.get(project, zone, instanceGroupManager); }
Note: close() needs to be called on the InstanceGroupManagersClient 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 InstanceGroupManagersSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library InstanceGroupManagersSettings instanceGroupManagersSettings = InstanceGroupManagersSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create(instanceGroupManagersSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library InstanceGroupManagersSettings instanceGroupManagersSettings = InstanceGroupManagersSettings.newBuilder().setEndpoint(myEndpoint).build(); InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create(instanceGroupManagersSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
-
Constructor Summary
Constructors Modifier Constructor Description protected
InstanceGroupManagersClient(InstanceGroupManagersSettings settings)
Constructs an instance of InstanceGroupManagersClient, using the given settings.protected
InstanceGroupManagersClient(InstanceGroupManagersStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
abandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest request)
Flags the specified instances to be removed from the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
abandonInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersAbandonInstancesRequest instanceGroupManagersAbandonInstancesRequestResource)
Flags the specified instances to be removed from the managed instance group.com.google.api.gax.rpc.UnaryCallable<AbandonInstancesInstanceGroupManagerRequest,Operation>
abandonInstancesCallable()
Flags the specified instances to be removed from the managed instance group.com.google.api.gax.rpc.OperationCallable<AbandonInstancesInstanceGroupManagerRequest,Operation,Operation>
abandonInstancesOperationCallable()
Flags the specified instances to be removed from the managed instance group.InstanceGroupManagersClient.AggregatedListPagedResponse
aggregatedList(AggregatedListInstanceGroupManagersRequest request)
Retrieves the list of managed instance groups and groups them by zone.InstanceGroupManagersClient.AggregatedListPagedResponse
aggregatedList(String project)
Retrieves the list of managed instance groups and groups them by zone.com.google.api.gax.rpc.UnaryCallable<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagerAggregatedList>
aggregatedListCallable()
Retrieves the list of managed instance groups and groups them by zone.com.google.api.gax.rpc.UnaryCallable<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagersClient.AggregatedListPagedResponse>
aggregatedListPagedCallable()
Retrieves the list of managed instance groups and groups them by zone.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest request)
Applies changes to selected instances on the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
applyUpdatesToInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersApplyUpdatesRequest instanceGroupManagersApplyUpdatesRequestResource)
Applies changes to selected instances on the managed instance group.com.google.api.gax.rpc.UnaryCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation>
applyUpdatesToInstancesCallable()
Applies changes to selected instances on the managed instance group.com.google.api.gax.rpc.OperationCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation,Operation>
applyUpdatesToInstancesOperationCallable()
Applies changes to selected instances on the managed instance group.boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static InstanceGroupManagersClient
create()
Constructs an instance of InstanceGroupManagersClient with default settings.static InstanceGroupManagersClient
create(InstanceGroupManagersSettings settings)
Constructs an instance of InstanceGroupManagersClient, using the given settings.static InstanceGroupManagersClient
create(InstanceGroupManagersStub stub)
Constructs an instance of InstanceGroupManagersClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
createInstancesAsync(CreateInstancesInstanceGroupManagerRequest request)
Creates instances with per-instance configurations in this managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
createInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersCreateInstancesRequest instanceGroupManagersCreateInstancesRequestResource)
Creates instances with per-instance configurations in this managed instance group.com.google.api.gax.rpc.UnaryCallable<CreateInstancesInstanceGroupManagerRequest,Operation>
createInstancesCallable()
Creates instances with per-instance configurations in this managed instance group.com.google.api.gax.rpc.OperationCallable<CreateInstancesInstanceGroupManagerRequest,Operation,Operation>
createInstancesOperationCallable()
Creates instances with per-instance configurations in this managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteInstanceGroupManagerRequest request)
Deletes the specified managed instance group and all of the instances in that group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String zone, String instanceGroupManager)
Deletes the specified managed instance group and all of the instances in that group.com.google.api.gax.rpc.UnaryCallable<DeleteInstanceGroupManagerRequest,Operation>
deleteCallable()
Deletes the specified managed instance group and all of the instances in that group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest request)
Flags the specified instances in the managed instance group for immediate deletion.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeleteInstancesRequest instanceGroupManagersDeleteInstancesRequestResource)
Flags the specified instances in the managed instance group for immediate deletion.com.google.api.gax.rpc.UnaryCallable<DeleteInstancesInstanceGroupManagerRequest,Operation>
deleteInstancesCallable()
Flags the specified instances in the managed instance group for immediate deletion.com.google.api.gax.rpc.OperationCallable<DeleteInstancesInstanceGroupManagerRequest,Operation,Operation>
deleteInstancesOperationCallable()
Flags the specified instances in the managed instance group for immediate deletion.com.google.api.gax.rpc.OperationCallable<DeleteInstanceGroupManagerRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified managed instance group and all of the instances in that group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest request)
Deletes selected per-instance configurations for the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deletePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeletePerInstanceConfigsReq instanceGroupManagersDeletePerInstanceConfigsReqResource)
Deletes selected per-instance configurations for the managed instance group.com.google.api.gax.rpc.UnaryCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation>
deletePerInstanceConfigsCallable()
Deletes selected per-instance configurations for the managed instance group.com.google.api.gax.rpc.OperationCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation>
deletePerInstanceConfigsOperationCallable()
Deletes selected per-instance configurations for the managed instance group.InstanceGroupManager
get(GetInstanceGroupManagerRequest request)
Returns all of the details about the specified managed instance group.InstanceGroupManager
get(String project, String zone, String instanceGroupManager)
Returns all of the details about the specified managed instance group.com.google.api.gax.rpc.UnaryCallable<GetInstanceGroupManagerRequest,InstanceGroupManager>
getCallable()
Returns all of the details about the specified managed instance group.InstanceGroupManagersSettings
getSettings()
InstanceGroupManagersStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertInstanceGroupManagerRequest request)
Creates a managed instance group using the information that you specify in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(String project, String zone, InstanceGroupManager instanceGroupManagerResource)
Creates a managed instance group using the information that you specify in the request.com.google.api.gax.rpc.UnaryCallable<InsertInstanceGroupManagerRequest,Operation>
insertCallable()
Creates a managed instance group using the information that you specify in the request.com.google.api.gax.rpc.OperationCallable<InsertInstanceGroupManagerRequest,Operation,Operation>
insertOperationCallable()
Creates a managed instance group using the information that you specify in the request.boolean
isShutdown()
boolean
isTerminated()
InstanceGroupManagersClient.ListPagedResponse
list(ListInstanceGroupManagersRequest request)
Retrieves a list of managed instance groups that are contained within the specified project and zone.InstanceGroupManagersClient.ListPagedResponse
list(String project, String zone)
Retrieves a list of managed instance groups that are contained within the specified project and zone.com.google.api.gax.rpc.UnaryCallable<ListInstanceGroupManagersRequest,InstanceGroupManagerList>
listCallable()
Retrieves a list of managed instance groups that are contained within the specified project and zone.InstanceGroupManagersClient.ListErrorsPagedResponse
listErrors(ListErrorsInstanceGroupManagersRequest request)
Lists all errors thrown by actions on instances for a given managed instance group.InstanceGroupManagersClient.ListErrorsPagedResponse
listErrors(String project, String zone, String instanceGroupManager)
Lists all errors thrown by actions on instances for a given managed instance group.com.google.api.gax.rpc.UnaryCallable<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersListErrorsResponse>
listErrorsCallable()
Lists all errors thrown by actions on instances for a given managed instance group.com.google.api.gax.rpc.UnaryCallable<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersClient.ListErrorsPagedResponse>
listErrorsPagedCallable()
Lists all errors thrown by actions on instances for a given managed instance group.InstanceGroupManagersClient.ListManagedInstancesPagedResponse
listManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request)
Lists all of the instances in the managed instance group.InstanceGroupManagersClient.ListManagedInstancesPagedResponse
listManagedInstances(String project, String zone, String instanceGroupManager)
Lists all of the instances in the managed instance group.com.google.api.gax.rpc.UnaryCallable<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersListManagedInstancesResponse>
listManagedInstancesCallable()
Lists all of the instances in the managed instance group.com.google.api.gax.rpc.UnaryCallable<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersClient.ListManagedInstancesPagedResponse>
listManagedInstancesPagedCallable()
Lists all of the instances in the managed instance group.com.google.api.gax.rpc.UnaryCallable<ListInstanceGroupManagersRequest,InstanceGroupManagersClient.ListPagedResponse>
listPagedCallable()
Retrieves a list of managed instance groups that are contained within the specified project and zone.InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse
listPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest request)
Lists all of the per-instance configurations defined for the managed instance group.InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse
listPerInstanceConfigs(String project, String zone, String instanceGroupManager)
Lists all of the per-instance configurations defined for the managed instance group.com.google.api.gax.rpc.UnaryCallable<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersListPerInstanceConfigsResp>
listPerInstanceConfigsCallable()
Lists all of the per-instance configurations defined for the managed instance group.com.google.api.gax.rpc.UnaryCallable<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse>
listPerInstanceConfigsPagedCallable()
Lists all of the per-instance configurations defined for the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(PatchInstanceGroupManagerRequest request)
Updates a managed instance group using the information that you specify in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(String project, String zone, String instanceGroupManager, InstanceGroupManager instanceGroupManagerResource)
Updates a managed instance group using the information that you specify in the request.com.google.api.gax.rpc.UnaryCallable<PatchInstanceGroupManagerRequest,Operation>
patchCallable()
Updates a managed instance group using the information that you specify in the request.com.google.api.gax.rpc.OperationCallable<PatchInstanceGroupManagerRequest,Operation,Operation>
patchOperationCallable()
Updates a managed instance group using the information that you specify in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest request)
Inserts or patches per-instance configurations for the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchPerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersPatchPerInstanceConfigsReq instanceGroupManagersPatchPerInstanceConfigsReqResource)
Inserts or patches per-instance configurations for the managed instance group.com.google.api.gax.rpc.UnaryCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation>
patchPerInstanceConfigsCallable()
Inserts or patches per-instance configurations for the managed instance group.com.google.api.gax.rpc.OperationCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation>
patchPerInstanceConfigsOperationCallable()
Inserts or patches per-instance configurations for the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
recreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest request)
Flags the specified VM instances in the managed instance group to be immediately recreated.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
recreateInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersRecreateInstancesRequest instanceGroupManagersRecreateInstancesRequestResource)
Flags the specified VM instances in the managed instance group to be immediately recreated.com.google.api.gax.rpc.UnaryCallable<RecreateInstancesInstanceGroupManagerRequest,Operation>
recreateInstancesCallable()
Flags the specified VM instances in the managed instance group to be immediately recreated.com.google.api.gax.rpc.OperationCallable<RecreateInstancesInstanceGroupManagerRequest,Operation,Operation>
recreateInstancesOperationCallable()
Flags the specified VM instances in the managed instance group to be immediately recreated.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
resizeAsync(ResizeInstanceGroupManagerRequest request)
Resizes the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
resizeAsync(String project, String zone, String instanceGroupManager, int size)
Resizes the managed instance group.com.google.api.gax.rpc.UnaryCallable<ResizeInstanceGroupManagerRequest,Operation>
resizeCallable()
Resizes the managed instance group.com.google.api.gax.rpc.OperationCallable<ResizeInstanceGroupManagerRequest,Operation,Operation>
resizeOperationCallable()
Resizes the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest request)
Specifies the instance template to use when creating new instances in this group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setInstanceTemplateAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetInstanceTemplateRequest instanceGroupManagersSetInstanceTemplateRequestResource)
Specifies the instance template to use when creating new instances in this group.com.google.api.gax.rpc.UnaryCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation>
setInstanceTemplateCallable()
Specifies the instance template to use when creating new instances in this group.com.google.api.gax.rpc.OperationCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation,Operation>
setInstanceTemplateOperationCallable()
Specifies the instance template to use when creating new instances in this group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest request)
Modifies the target pools to which all instances in this managed instance group are assigned.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
setTargetPoolsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetTargetPoolsRequest instanceGroupManagersSetTargetPoolsRequestResource)
Modifies the target pools to which all instances in this managed instance group are assigned.com.google.api.gax.rpc.UnaryCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation>
setTargetPoolsCallable()
Modifies the target pools to which all instances in this managed instance group are assigned.com.google.api.gax.rpc.OperationCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation,Operation>
setTargetPoolsOperationCallable()
Modifies the target pools to which all instances in this managed instance group are assigned.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest request)
Inserts or updates per-instance configurations for the managed instance group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updatePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersUpdatePerInstanceConfigsReq instanceGroupManagersUpdatePerInstanceConfigsReqResource)
Inserts or updates per-instance configurations for the managed instance group.com.google.api.gax.rpc.UnaryCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation>
updatePerInstanceConfigsCallable()
Inserts or updates per-instance configurations for the managed instance group.com.google.api.gax.rpc.OperationCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation>
updatePerInstanceConfigsOperationCallable()
Inserts or updates per-instance configurations for the managed instance group.
-
-
-
Constructor Detail
-
InstanceGroupManagersClient
protected InstanceGroupManagersClient(InstanceGroupManagersSettings settings) throws IOException
Constructs an instance of InstanceGroupManagersClient, 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
-
InstanceGroupManagersClient
protected InstanceGroupManagersClient(InstanceGroupManagersStub stub)
-
-
Method Detail
-
create
public static final InstanceGroupManagersClient create() throws IOException
Constructs an instance of InstanceGroupManagersClient with default settings.- Throws:
IOException
-
create
public static final InstanceGroupManagersClient create(InstanceGroupManagersSettings settings) throws IOException
Constructs an instance of InstanceGroupManagersClient, 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
public static final InstanceGroupManagersClient create(InstanceGroupManagersStub stub)
Constructs an instance of InstanceGroupManagersClient, using the given stub for making calls. This is for advanced usage - prefer using create(InstanceGroupManagersSettings).
-
getSettings
public final InstanceGroupManagersSettings getSettings()
-
getStub
public InstanceGroupManagersStub getStub()
-
abandonInstancesAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> abandonInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersAbandonInstancesRequest instanceGroupManagersAbandonInstancesRequestResource)
Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersAbandonInstancesRequest instanceGroupManagersAbandonInstancesRequestResource = InstanceGroupManagersAbandonInstancesRequest.newBuilder().build(); Operation response = instanceGroupManagersClient .abandonInstancesAsync( project, zone, instanceGroupManager, instanceGroupManagersAbandonInstancesRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.instanceGroupManagersAbandonInstancesRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
abandonInstancesAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> abandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest request)
Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { AbandonInstancesInstanceGroupManagerRequest request = AbandonInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersAbandonInstancesRequestResource( InstanceGroupManagersAbandonInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.abandonInstancesAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
abandonInstancesOperationCallable
public final com.google.api.gax.rpc.OperationCallable<AbandonInstancesInstanceGroupManagerRequest,Operation,Operation> abandonInstancesOperationCallable()
Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { AbandonInstancesInstanceGroupManagerRequest request = AbandonInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersAbandonInstancesRequestResource( InstanceGroupManagersAbandonInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.abandonInstancesOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
abandonInstancesCallable
public final com.google.api.gax.rpc.UnaryCallable<AbandonInstancesInstanceGroupManagerRequest,Operation> abandonInstancesCallable()
Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { AbandonInstancesInstanceGroupManagerRequest request = AbandonInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersAbandonInstancesRequestResource( InstanceGroupManagersAbandonInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.abandonInstancesCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
aggregatedList
public final InstanceGroupManagersClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves the list of managed instance groups and groups them by zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; for (Map.Entry<String, InstanceGroupManagersScopedList> element : instanceGroupManagersClient.aggregatedList(project).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedList
public final InstanceGroupManagersClient.AggregatedListPagedResponse aggregatedList(AggregatedListInstanceGroupManagersRequest request)
Retrieves the list of managed instance groups and groups them by zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { AggregatedListInstanceGroupManagersRequest request = AggregatedListInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setIncludeAllScopes(true) .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); for (Map.Entry<String, InstanceGroupManagersScopedList> element : instanceGroupManagersClient.aggregatedList(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedListPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagersClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves the list of managed instance groups and groups them by zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { AggregatedListInstanceGroupManagersRequest request = AggregatedListInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setIncludeAllScopes(true) .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); ApiFuture<Map.Entry<String, InstanceGroupManagersScopedList>> future = instanceGroupManagersClient.aggregatedListPagedCallable().futureCall(request); // Do something. for (Map.Entry<String, InstanceGroupManagersScopedList> element : future.get().iterateAll()) { // doThingsWith(element); } }
-
aggregatedListCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagerAggregatedList> aggregatedListCallable()
Retrieves the list of managed instance groups and groups them by zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { AggregatedListInstanceGroupManagersRequest request = AggregatedListInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setIncludeAllScopes(true) .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); while (true) { InstanceGroupManagerAggregatedList response = instanceGroupManagersClient.aggregatedListCallable().call(request); for (Map.Entry<String, InstanceGroupManagersScopedList> element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
applyUpdatesToInstancesAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> applyUpdatesToInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersApplyUpdatesRequest instanceGroupManagersApplyUpdatesRequestResource)
Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersApplyUpdatesRequest instanceGroupManagersApplyUpdatesRequestResource = InstanceGroupManagersApplyUpdatesRequest.newBuilder().build(); Operation response = instanceGroupManagersClient .applyUpdatesToInstancesAsync( project, zone, instanceGroupManager, instanceGroupManagersApplyUpdatesRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located. Should conform to RFC1035.instanceGroupManager
- The name of the managed instance group, should conform to RFC1035.instanceGroupManagersApplyUpdatesRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
applyUpdatesToInstancesAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> applyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest request)
Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ApplyUpdatesToInstancesInstanceGroupManagerRequest request = ApplyUpdatesToInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersApplyUpdatesRequestResource( InstanceGroupManagersApplyUpdatesRequest.newBuilder().build()) .setProject("project-309310695") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.applyUpdatesToInstancesAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
applyUpdatesToInstancesOperationCallable
public final com.google.api.gax.rpc.OperationCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation,Operation> applyUpdatesToInstancesOperationCallable()
Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ApplyUpdatesToInstancesInstanceGroupManagerRequest request = ApplyUpdatesToInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersApplyUpdatesRequestResource( InstanceGroupManagersApplyUpdatesRequest.newBuilder().build()) .setProject("project-309310695") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient .applyUpdatesToInstancesOperationCallable() .futureCall(request); // Do something. Operation response = future.get(); }
-
applyUpdatesToInstancesCallable
public final com.google.api.gax.rpc.UnaryCallable<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation> applyUpdatesToInstancesCallable()
Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ApplyUpdatesToInstancesInstanceGroupManagerRequest request = ApplyUpdatesToInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersApplyUpdatesRequestResource( InstanceGroupManagersApplyUpdatesRequest.newBuilder().build()) .setProject("project-309310695") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.applyUpdatesToInstancesCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
createInstancesAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> createInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersCreateInstancesRequest instanceGroupManagersCreateInstancesRequestResource)
Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersCreateInstancesRequest instanceGroupManagersCreateInstancesRequestResource = InstanceGroupManagersCreateInstancesRequest.newBuilder().build(); Operation response = instanceGroupManagersClient .createInstancesAsync( project, zone, instanceGroupManager, instanceGroupManagersCreateInstancesRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located. It should conform to RFC1035.instanceGroupManager
- The name of the managed instance group. It should conform to RFC1035.instanceGroupManagersCreateInstancesRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createInstancesAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> createInstancesAsync(CreateInstancesInstanceGroupManagerRequest request)
Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { CreateInstancesInstanceGroupManagerRequest request = CreateInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersCreateInstancesRequestResource( InstanceGroupManagersCreateInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.createInstancesAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createInstancesOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateInstancesInstanceGroupManagerRequest,Operation,Operation> createInstancesOperationCallable()
Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { CreateInstancesInstanceGroupManagerRequest request = CreateInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersCreateInstancesRequestResource( InstanceGroupManagersCreateInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.createInstancesOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
createInstancesCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateInstancesInstanceGroupManagerRequest,Operation> createInstancesCallable()
Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { CreateInstancesInstanceGroupManagerRequest request = CreateInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersCreateInstancesRequestResource( InstanceGroupManagersCreateInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.createInstancesCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String zone, String instanceGroupManager)
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; Operation response = instanceGroupManagersClient.deleteAsync(project, zone, instanceGroupManager).get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteInstanceGroupManagerRequest request)
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeleteInstanceGroupManagerRequest request = DeleteInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.deleteAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteInstanceGroupManagerRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeleteInstanceGroupManagerRequest request = DeleteInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.deleteOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteInstanceGroupManagerRequest,Operation> deleteCallable()
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeleteInstanceGroupManagerRequest request = DeleteInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.deleteCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteInstancesAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeleteInstancesRequest instanceGroupManagersDeleteInstancesRequestResource)
Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersDeleteInstancesRequest instanceGroupManagersDeleteInstancesRequestResource = InstanceGroupManagersDeleteInstancesRequest.newBuilder().build(); Operation response = instanceGroupManagersClient .deleteInstancesAsync( project, zone, instanceGroupManager, instanceGroupManagersDeleteInstancesRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.instanceGroupManagersDeleteInstancesRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteInstancesAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest request)
Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeleteInstancesInstanceGroupManagerRequest request = DeleteInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersDeleteInstancesRequestResource( InstanceGroupManagersDeleteInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.deleteInstancesAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteInstancesOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteInstancesInstanceGroupManagerRequest,Operation,Operation> deleteInstancesOperationCallable()
Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeleteInstancesInstanceGroupManagerRequest request = DeleteInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersDeleteInstancesRequestResource( InstanceGroupManagersDeleteInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.deleteInstancesOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteInstancesCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteInstancesInstanceGroupManagerRequest,Operation> deleteInstancesCallable()
Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeleteInstancesInstanceGroupManagerRequest request = DeleteInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersDeleteInstancesRequestResource( InstanceGroupManagersDeleteInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.deleteInstancesCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deletePerInstanceConfigsAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deletePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersDeletePerInstanceConfigsReq instanceGroupManagersDeletePerInstanceConfigsReqResource)
Deletes selected per-instance configurations for the managed instance group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersDeletePerInstanceConfigsReq instanceGroupManagersDeletePerInstanceConfigsReqResource = InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build(); Operation response = instanceGroupManagersClient .deletePerInstanceConfigsAsync( project, zone, instanceGroupManager, instanceGroupManagersDeletePerInstanceConfigsReqResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located. It should conform to RFC1035.instanceGroupManager
- The name of the managed instance group. It should conform to RFC1035.instanceGroupManagersDeletePerInstanceConfigsReqResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deletePerInstanceConfigsAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest request)
Deletes selected per-instance configurations for the managed instance group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeletePerInstanceConfigsInstanceGroupManagerRequest request = DeletePerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersDeletePerInstanceConfigsReqResource( InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.deletePerInstanceConfigsAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deletePerInstanceConfigsOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> deletePerInstanceConfigsOperationCallable()
Deletes selected per-instance configurations for the managed instance group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeletePerInstanceConfigsInstanceGroupManagerRequest request = DeletePerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersDeletePerInstanceConfigsReqResource( InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient .deletePerInstanceConfigsOperationCallable() .futureCall(request); // Do something. Operation response = future.get(); }
-
deletePerInstanceConfigsCallable
public final com.google.api.gax.rpc.UnaryCallable<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation> deletePerInstanceConfigsCallable()
Deletes selected per-instance configurations for the managed instance group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { DeletePerInstanceConfigsInstanceGroupManagerRequest request = DeletePerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersDeletePerInstanceConfigsReqResource( InstanceGroupManagersDeletePerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.deletePerInstanceConfigsCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
get
public final InstanceGroupManager get(String project, String zone, String instanceGroupManager)
Returns all of the details about the specified managed instance group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManager response = instanceGroupManagersClient.get(project, zone, instanceGroupManager); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final InstanceGroupManager get(GetInstanceGroupManagerRequest request)
Returns all of the details about the specified managed instance group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { GetInstanceGroupManagerRequest request = GetInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setZone("zone3744684") .build(); InstanceGroupManager response = instanceGroupManagersClient.get(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCallable
public final com.google.api.gax.rpc.UnaryCallable<GetInstanceGroupManagerRequest,InstanceGroupManager> getCallable()
Returns all of the details about the specified managed instance group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { GetInstanceGroupManagerRequest request = GetInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setZone("zone3744684") .build(); ApiFuture<InstanceGroupManager> future = instanceGroupManagersClient.getCallable().futureCall(request); // Do something. InstanceGroupManager response = future.get(); }
-
insertAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, String zone, InstanceGroupManager instanceGroupManagerResource)
Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; InstanceGroupManager instanceGroupManagerResource = InstanceGroupManager.newBuilder().build(); Operation response = instanceGroupManagersClient .insertAsync(project, zone, instanceGroupManagerResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where you want to create the managed instance group.instanceGroupManagerResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertInstanceGroupManagerRequest request)
Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { InsertInstanceGroupManagerRequest request = InsertInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.insertAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertOperationCallable
public final com.google.api.gax.rpc.OperationCallable<InsertInstanceGroupManagerRequest,Operation,Operation> insertOperationCallable()
Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { InsertInstanceGroupManagerRequest request = InsertInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.insertOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertInstanceGroupManagerRequest,Operation> insertCallable()
Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { InsertInstanceGroupManagerRequest request = InsertInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.insertCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
list
public final InstanceGroupManagersClient.ListPagedResponse list(String project, String zone)
Retrieves a list of managed instance groups that are contained within the specified project and zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; for (InstanceGroupManager element : instanceGroupManagersClient.list(project, zone).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
public final InstanceGroupManagersClient.ListPagedResponse list(ListInstanceGroupManagersRequest request)
Retrieves a list of managed instance groups that are contained within the specified project and zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListInstanceGroupManagersRequest request = ListInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); for (InstanceGroupManager element : instanceGroupManagersClient.list(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListInstanceGroupManagersRequest,InstanceGroupManagersClient.ListPagedResponse> listPagedCallable()
Retrieves a list of managed instance groups that are contained within the specified project and zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListInstanceGroupManagersRequest request = ListInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); ApiFuture<InstanceGroupManager> future = instanceGroupManagersClient.listPagedCallable().futureCall(request); // Do something. for (InstanceGroupManager element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListInstanceGroupManagersRequest,InstanceGroupManagerList> listCallable()
Retrieves a list of managed instance groups that are contained within the specified project and zone.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListInstanceGroupManagersRequest request = ListInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); while (true) { InstanceGroupManagerList response = instanceGroupManagersClient.listCallable().call(request); for (InstanceGroupManager element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listErrors
public final InstanceGroupManagersClient.ListErrorsPagedResponse listErrors(String project, String zone, String instanceGroupManager)
Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; for (InstanceManagedByIgmError element : instanceGroupManagersClient .listErrors(project, zone, instanceGroupManager) .iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located. It should conform to RFC1035.instanceGroupManager
- The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listErrors
public final InstanceGroupManagersClient.ListErrorsPagedResponse listErrors(ListErrorsInstanceGroupManagersRequest request)
Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListErrorsInstanceGroupManagersRequest request = ListErrorsInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); for (InstanceManagedByIgmError element : instanceGroupManagersClient.listErrors(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listErrorsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersClient.ListErrorsPagedResponse> listErrorsPagedCallable()
Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListErrorsInstanceGroupManagersRequest request = ListErrorsInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); ApiFuture<InstanceManagedByIgmError> future = instanceGroupManagersClient.listErrorsPagedCallable().futureCall(request); // Do something. for (InstanceManagedByIgmError element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listErrorsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersListErrorsResponse> listErrorsCallable()
Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListErrorsInstanceGroupManagersRequest request = ListErrorsInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); while (true) { InstanceGroupManagersListErrorsResponse response = instanceGroupManagersClient.listErrorsCallable().call(request); for (InstanceManagedByIgmError element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listManagedInstances
public final InstanceGroupManagersClient.ListManagedInstancesPagedResponse listManagedInstances(String project, String zone, String instanceGroupManager)
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; for (ManagedInstance element : instanceGroupManagersClient .listManagedInstances(project, zone, instanceGroupManager) .iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listManagedInstances
public final InstanceGroupManagersClient.ListManagedInstancesPagedResponse listManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request)
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListManagedInstancesInstanceGroupManagersRequest request = ListManagedInstancesInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); for (ManagedInstance element : instanceGroupManagersClient.listManagedInstances(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listManagedInstancesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersClient.ListManagedInstancesPagedResponse> listManagedInstancesPagedCallable()
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListManagedInstancesInstanceGroupManagersRequest request = ListManagedInstancesInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); ApiFuture<ManagedInstance> future = instanceGroupManagersClient.listManagedInstancesPagedCallable().futureCall(request); // Do something. for (ManagedInstance element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listManagedInstancesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersListManagedInstancesResponse> listManagedInstancesCallable()
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListManagedInstancesInstanceGroupManagersRequest request = ListManagedInstancesInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); while (true) { InstanceGroupManagersListManagedInstancesResponse response = instanceGroupManagersClient.listManagedInstancesCallable().call(request); for (ManagedInstance element : response.getManagedInstancesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listPerInstanceConfigs
public final InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse listPerInstanceConfigs(String project, String zone, String instanceGroupManager)
Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; for (PerInstanceConfig element : instanceGroupManagersClient .listPerInstanceConfigs(project, zone, instanceGroupManager) .iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located. It should conform to RFC1035.instanceGroupManager
- The name of the managed instance group. It should conform to RFC1035.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPerInstanceConfigs
public final InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse listPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest request)
Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListPerInstanceConfigsInstanceGroupManagersRequest request = ListPerInstanceConfigsInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); for (PerInstanceConfig element : instanceGroupManagersClient.listPerInstanceConfigs(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPerInstanceConfigsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse> listPerInstanceConfigsPagedCallable()
Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListPerInstanceConfigsInstanceGroupManagersRequest request = ListPerInstanceConfigsInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); ApiFuture<PerInstanceConfig> future = instanceGroupManagersClient.listPerInstanceConfigsPagedCallable().futureCall(request); // Do something. for (PerInstanceConfig element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listPerInstanceConfigsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersListPerInstanceConfigsResp> listPerInstanceConfigsCallable()
Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ListPerInstanceConfigsInstanceGroupManagersRequest request = ListPerInstanceConfigsInstanceGroupManagersRequest.newBuilder() .setFilter("filter-1274492040") .setInstanceGroupManager("instanceGroupManager-388242077") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .setZone("zone3744684") .build(); while (true) { InstanceGroupManagersListPerInstanceConfigsResp response = instanceGroupManagersClient.listPerInstanceConfigsCallable().call(request); for (PerInstanceConfig element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
patchAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project, String zone, String instanceGroupManager, InstanceGroupManager instanceGroupManagerResource)
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManager instanceGroupManagerResource = InstanceGroupManager.newBuilder().build(); Operation response = instanceGroupManagersClient .patchAsync(project, zone, instanceGroupManager, instanceGroupManagerResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where you want to create the managed instance group.instanceGroupManager
- The name of the instance group manager.instanceGroupManagerResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchInstanceGroupManagerRequest request)
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { PatchInstanceGroupManagerRequest request = PatchInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.patchAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchOperationCallable
public final com.google.api.gax.rpc.OperationCallable<PatchInstanceGroupManagerRequest,Operation,Operation> patchOperationCallable()
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { PatchInstanceGroupManagerRequest request = PatchInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.patchOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
patchCallable
public final com.google.api.gax.rpc.UnaryCallable<PatchInstanceGroupManagerRequest,Operation> patchCallable()
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { PatchInstanceGroupManagerRequest request = PatchInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagerResource(InstanceGroupManager.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.patchCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
patchPerInstanceConfigsAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchPerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersPatchPerInstanceConfigsReq instanceGroupManagersPatchPerInstanceConfigsReqResource)
Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersPatchPerInstanceConfigsReq instanceGroupManagersPatchPerInstanceConfigsReqResource = InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build(); Operation response = instanceGroupManagersClient .patchPerInstanceConfigsAsync( project, zone, instanceGroupManager, instanceGroupManagersPatchPerInstanceConfigsReqResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located. It should conform to RFC1035.instanceGroupManager
- The name of the managed instance group. It should conform to RFC1035.instanceGroupManagersPatchPerInstanceConfigsReqResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchPerInstanceConfigsAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest request)
Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { PatchPerInstanceConfigsInstanceGroupManagerRequest request = PatchPerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersPatchPerInstanceConfigsReqResource( InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.patchPerInstanceConfigsAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchPerInstanceConfigsOperationCallable
public final com.google.api.gax.rpc.OperationCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> patchPerInstanceConfigsOperationCallable()
Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { PatchPerInstanceConfigsInstanceGroupManagerRequest request = PatchPerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersPatchPerInstanceConfigsReqResource( InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient .patchPerInstanceConfigsOperationCallable() .futureCall(request); // Do something. Operation response = future.get(); }
-
patchPerInstanceConfigsCallable
public final com.google.api.gax.rpc.UnaryCallable<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation> patchPerInstanceConfigsCallable()
Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { PatchPerInstanceConfigsInstanceGroupManagerRequest request = PatchPerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersPatchPerInstanceConfigsReqResource( InstanceGroupManagersPatchPerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.patchPerInstanceConfigsCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
recreateInstancesAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> recreateInstancesAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersRecreateInstancesRequest instanceGroupManagersRecreateInstancesRequestResource)
Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersRecreateInstancesRequest instanceGroupManagersRecreateInstancesRequestResource = InstanceGroupManagersRecreateInstancesRequest.newBuilder().build(); Operation response = instanceGroupManagersClient .recreateInstancesAsync( project, zone, instanceGroupManager, instanceGroupManagersRecreateInstancesRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.instanceGroupManagersRecreateInstancesRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
recreateInstancesAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> recreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest request)
Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { RecreateInstancesInstanceGroupManagerRequest request = RecreateInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersRecreateInstancesRequestResource( InstanceGroupManagersRecreateInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.recreateInstancesAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
recreateInstancesOperationCallable
public final com.google.api.gax.rpc.OperationCallable<RecreateInstancesInstanceGroupManagerRequest,Operation,Operation> recreateInstancesOperationCallable()
Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { RecreateInstancesInstanceGroupManagerRequest request = RecreateInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersRecreateInstancesRequestResource( InstanceGroupManagersRecreateInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.recreateInstancesOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
recreateInstancesCallable
public final com.google.api.gax.rpc.UnaryCallable<RecreateInstancesInstanceGroupManagerRequest,Operation> recreateInstancesCallable()
Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { RecreateInstancesInstanceGroupManagerRequest request = RecreateInstancesInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersRecreateInstancesRequestResource( InstanceGroupManagersRecreateInstancesRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.recreateInstancesCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
resizeAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> resizeAsync(String project, String zone, String instanceGroupManager, int size)
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; int size = 3530753; Operation response = instanceGroupManagersClient.resizeAsync(project, zone, instanceGroupManager, size).get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.size
- The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
resizeAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> resizeAsync(ResizeInstanceGroupManagerRequest request)
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ResizeInstanceGroupManagerRequest request = ResizeInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setRequestId("requestId693933066") .setSize(3530753) .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.resizeAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
resizeOperationCallable
public final com.google.api.gax.rpc.OperationCallable<ResizeInstanceGroupManagerRequest,Operation,Operation> resizeOperationCallable()
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ResizeInstanceGroupManagerRequest request = ResizeInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setRequestId("requestId693933066") .setSize(3530753) .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.resizeOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
resizeCallable
public final com.google.api.gax.rpc.UnaryCallable<ResizeInstanceGroupManagerRequest,Operation> resizeCallable()
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { ResizeInstanceGroupManagerRequest request = ResizeInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setProject("project-309310695") .setRequestId("requestId693933066") .setSize(3530753) .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.resizeCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
setInstanceTemplateAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setInstanceTemplateAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetInstanceTemplateRequest instanceGroupManagersSetInstanceTemplateRequestResource)
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersSetInstanceTemplateRequest instanceGroupManagersSetInstanceTemplateRequestResource = InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build(); Operation response = instanceGroupManagersClient .setInstanceTemplateAsync( project, zone, instanceGroupManager, instanceGroupManagersSetInstanceTemplateRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.instanceGroupManagersSetInstanceTemplateRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setInstanceTemplateAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest request)
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { SetInstanceTemplateInstanceGroupManagerRequest request = SetInstanceTemplateInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersSetInstanceTemplateRequestResource( InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.setInstanceTemplateAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setInstanceTemplateOperationCallable
public final com.google.api.gax.rpc.OperationCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation,Operation> setInstanceTemplateOperationCallable()
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { SetInstanceTemplateInstanceGroupManagerRequest request = SetInstanceTemplateInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersSetInstanceTemplateRequestResource( InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.setInstanceTemplateOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
setInstanceTemplateCallable
public final com.google.api.gax.rpc.UnaryCallable<SetInstanceTemplateInstanceGroupManagerRequest,Operation> setInstanceTemplateCallable()
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { SetInstanceTemplateInstanceGroupManagerRequest request = SetInstanceTemplateInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersSetInstanceTemplateRequestResource( InstanceGroupManagersSetInstanceTemplateRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.setInstanceTemplateCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
setTargetPoolsAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setTargetPoolsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersSetTargetPoolsRequest instanceGroupManagersSetTargetPoolsRequestResource)
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersSetTargetPoolsRequest instanceGroupManagersSetTargetPoolsRequestResource = InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build(); Operation response = instanceGroupManagersClient .setTargetPoolsAsync( project, zone, instanceGroupManager, instanceGroupManagersSetTargetPoolsRequestResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located.instanceGroupManager
- The name of the managed instance group.instanceGroupManagersSetTargetPoolsRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setTargetPoolsAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest request)
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { SetTargetPoolsInstanceGroupManagerRequest request = SetTargetPoolsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersSetTargetPoolsRequestResource( InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.setTargetPoolsAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setTargetPoolsOperationCallable
public final com.google.api.gax.rpc.OperationCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation,Operation> setTargetPoolsOperationCallable()
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { SetTargetPoolsInstanceGroupManagerRequest request = SetTargetPoolsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersSetTargetPoolsRequestResource( InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient.setTargetPoolsOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
setTargetPoolsCallable
public final com.google.api.gax.rpc.UnaryCallable<SetTargetPoolsInstanceGroupManagerRequest,Operation> setTargetPoolsCallable()
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { SetTargetPoolsInstanceGroupManagerRequest request = SetTargetPoolsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersSetTargetPoolsRequestResource( InstanceGroupManagersSetTargetPoolsRequest.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.setTargetPoolsCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
updatePerInstanceConfigsAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> updatePerInstanceConfigsAsync(String project, String zone, String instanceGroupManager, InstanceGroupManagersUpdatePerInstanceConfigsReq instanceGroupManagersUpdatePerInstanceConfigsReqResource)
Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { String project = "project-309310695"; String zone = "zone3744684"; String instanceGroupManager = "instanceGroupManager-388242077"; InstanceGroupManagersUpdatePerInstanceConfigsReq instanceGroupManagersUpdatePerInstanceConfigsReqResource = InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build(); Operation response = instanceGroupManagersClient .updatePerInstanceConfigsAsync( project, zone, instanceGroupManager, instanceGroupManagersUpdatePerInstanceConfigsReqResource) .get(); }
- Parameters:
project
- Project ID for this request.zone
- The name of the zone where the managed instance group is located. It should conform to RFC1035.instanceGroupManager
- The name of the managed instance group. It should conform to RFC1035.instanceGroupManagersUpdatePerInstanceConfigsReqResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updatePerInstanceConfigsAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> updatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest request)
Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { UpdatePerInstanceConfigsInstanceGroupManagerRequest request = UpdatePerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersUpdatePerInstanceConfigsReqResource( InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); Operation response = instanceGroupManagersClient.updatePerInstanceConfigsAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updatePerInstanceConfigsOperationCallable
public final com.google.api.gax.rpc.OperationCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> updatePerInstanceConfigsOperationCallable()
Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { UpdatePerInstanceConfigsInstanceGroupManagerRequest request = UpdatePerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersUpdatePerInstanceConfigsReqResource( InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); OperationFuture<Operation, Operation> future = instanceGroupManagersClient .updatePerInstanceConfigsOperationCallable() .futureCall(request); // Do something. Operation response = future.get(); }
-
updatePerInstanceConfigsCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation> updatePerInstanceConfigsCallable()
Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (InstanceGroupManagersClient instanceGroupManagersClient = InstanceGroupManagersClient.create()) { UpdatePerInstanceConfigsInstanceGroupManagerRequest request = UpdatePerInstanceConfigsInstanceGroupManagerRequest.newBuilder() .setInstanceGroupManager("instanceGroupManager-388242077") .setInstanceGroupManagersUpdatePerInstanceConfigsReqResource( InstanceGroupManagersUpdatePerInstanceConfigsReq.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .setZone("zone3744684") .build(); ApiFuture<Operation> future = instanceGroupManagersClient.updatePerInstanceConfigsCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-