Class RegionInstanceGroupsClient (1.59.0)

Service Description: The RegionInstanceGroups 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   InstanceGroup response = regionInstanceGroupsClient.get(project, region, instanceGroup);
 }
 

Note: close() needs to be called on the RegionInstanceGroupsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

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 RegionInstanceGroupsSettings 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
 RegionInstanceGroupsSettings regionInstanceGroupsSettings =
     RegionInstanceGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create(regionInstanceGroupsSettings);
 

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
 RegionInstanceGroupsSettings regionInstanceGroupsSettings =
     RegionInstanceGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create(regionInstanceGroupsSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Constructs an instance of RegionInstanceGroupsClient with default settings.

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

Constructs an instance of RegionInstanceGroupsClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionInstanceGroupsSettings).

Constructs an instance of RegionInstanceGroupsClient, 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.

Returns the specified instance group resource.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   GetRegionInstanceGroupRequest request =
       GetRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   InstanceGroup response = regionInstanceGroupsClient.get(request);
 }
 

Returns the specified instance group resource.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   InstanceGroup response = regionInstanceGroupsClient.get(project, region, instanceGroup);
 }
 

Returns the specified instance group resource.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   GetRegionInstanceGroupRequest request =
       GetRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<InstanceGroup> future =
       regionInstanceGroupsClient.getCallable().futureCall(request);
   // Do something.
   InstanceGroup response = future.get();
 }
 

Retrieves the list of instance group resources contained within the specified region.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListRegionInstanceGroupsRequest request =
       ListRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (InstanceGroup element : regionInstanceGroupsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Retrieves the list of instance group resources contained within the specified region.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (InstanceGroup element : regionInstanceGroupsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Retrieves the list of instance group resources contained within the specified region.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListRegionInstanceGroupsRequest request =
       ListRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RegionInstanceGroupList response = regionInstanceGroupsClient.listCallable().call(request);
     for (InstanceGroup element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListInstancesRegionInstanceGroupsRequest request =
       ListInstancesRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroup("instanceGroup-1404696854")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsListInstancesRequestResource(
               RegionInstanceGroupsListInstancesRequest.newBuilder().build())
           .setReturnPartialSuccess(true)
           .build();
   for (InstanceWithNamedPorts element :
       regionInstanceGroupsClient.listInstances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource =
       RegionInstanceGroupsListInstancesRequest.newBuilder().build();
   for (InstanceWithNamedPorts element :
       regionInstanceGroupsClient
           .listInstances(
               project, region, instanceGroup, regionInstanceGroupsListInstancesRequestResource)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListInstancesRegionInstanceGroupsRequest request =
       ListInstancesRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroup("instanceGroup-1404696854")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsListInstancesRequestResource(
               RegionInstanceGroupsListInstancesRequest.newBuilder().build())
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RegionInstanceGroupsListInstances response =
         regionInstanceGroupsClient.listInstancesCallable().call(request);
     for (InstanceWithNamedPorts element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListInstancesRegionInstanceGroupsRequest request =
       ListInstancesRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setInstanceGroup("instanceGroup-1404696854")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsListInstancesRequestResource(
               RegionInstanceGroupsListInstancesRequest.newBuilder().build())
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<InstanceWithNamedPorts> future =
       regionInstanceGroupsClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (InstanceWithNamedPorts element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Retrieves the list of instance group resources contained within the specified region.

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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   ListRegionInstanceGroupsRequest request =
       ListRegionInstanceGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<InstanceGroup> future =
       regionInstanceGroupsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (InstanceGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Sets the named ports for the specified regional 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   SetNamedPortsRegionInstanceGroupRequest request =
       SetNamedPortsRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsSetNamedPortsRequestResource(
               RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionInstanceGroupsClient.setNamedPortsAsync(request).get();
 }
 

Sets the named ports for the specified regional 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceGroup = "instanceGroup-1404696854";
   RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource =
       RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build();
   Operation response =
       regionInstanceGroupsClient
           .setNamedPortsAsync(
               project, region, instanceGroup, regionInstanceGroupsSetNamedPortsRequestResource)
           .get();
 }
 

Sets the named ports for the specified regional 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   SetNamedPortsRegionInstanceGroupRequest request =
       SetNamedPortsRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsSetNamedPortsRequestResource(
               RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionInstanceGroupsClient.setNamedPortsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Sets the named ports for the specified regional 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 (RegionInstanceGroupsClient regionInstanceGroupsClient =
     RegionInstanceGroupsClient.create()) {
   SetNamedPortsRegionInstanceGroupRequest request =
       SetNamedPortsRegionInstanceGroupRequest.newBuilder()
           .setInstanceGroup("instanceGroup-1404696854")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionInstanceGroupsSetNamedPortsRequestResource(
               RegionInstanceGroupsSetNamedPortsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionInstanceGroupsClient.setNamedPortsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }