Class RegionInstanceGroupsClient (1.51.0)

GitHub RepositoryProduct Reference

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().

Methods
MethodDescriptionMethod Variants

Get

Returns the specified instance group resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetRegionInstanceGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String region, String instanceGroup)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

List

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListRegionInstanceGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project, String region)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

ListInstances

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInstances(ListInstancesRegionInstanceGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInstances(String project, String region, String instanceGroup, RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInstancesPagedCallable()

  • listInstancesCallable()

SetNamedPorts

Sets the named ports for the specified regional instance group.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setNamedPortsAsync(String project, String region, String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setNamedPortsOperationCallable()

  • setNamedPortsCallable()

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.

Inheritance

java.lang.Object > RegionInstanceGroupsClient

Static Methods

create()

public static final RegionInstanceGroupsClient create()

Constructs an instance of RegionInstanceGroupsClient with default settings.

Returns
TypeDescription
RegionInstanceGroupsClient
Exceptions
TypeDescription
IOException

create(RegionInstanceGroupsSettings settings)

public static final RegionInstanceGroupsClient create(RegionInstanceGroupsSettings 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.

Parameter
NameDescription
settingsRegionInstanceGroupsSettings
Returns
TypeDescription
RegionInstanceGroupsClient
Exceptions
TypeDescription
IOException

create(RegionInstanceGroupsStub stub)

public static final RegionInstanceGroupsClient create(RegionInstanceGroupsStub stub)

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

Parameter
NameDescription
stubRegionInstanceGroupsStub
Returns
TypeDescription
RegionInstanceGroupsClient

Constructors

RegionInstanceGroupsClient(RegionInstanceGroupsSettings settings)

protected RegionInstanceGroupsClient(RegionInstanceGroupsSettings settings)

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.

Parameter
NameDescription
settingsRegionInstanceGroupsSettings

RegionInstanceGroupsClient(RegionInstanceGroupsStub stub)

protected RegionInstanceGroupsClient(RegionInstanceGroupsStub stub)
Parameter
NameDescription
stubRegionInstanceGroupsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

get(GetRegionInstanceGroupRequest request)

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

The request object containing all of the parameters for the API call.

Returns
TypeDescription
InstanceGroup

get(String project, String region, String instanceGroup)

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

Project ID for this request.

regionString

Name of the region scoping this request.

instanceGroupString

Name of the instance group resource to return.

Returns
TypeDescription
InstanceGroup

getCallable()

public final UnaryCallable<GetRegionInstanceGroupRequest,InstanceGroup> getCallable()

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();
 }
Returns
TypeDescription
UnaryCallable<GetRegionInstanceGroupRequest,InstanceGroup>

getSettings()

public final RegionInstanceGroupsSettings getSettings()
Returns
TypeDescription
RegionInstanceGroupsSettings

getStub()

public RegionInstanceGroupsStub getStub()
Returns
TypeDescription
RegionInstanceGroupsStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

list(ListRegionInstanceGroupsRequest request)

public final RegionInstanceGroupsClient.ListPagedResponse list(ListRegionInstanceGroupsRequest request)

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);
   }
 }
Parameter
NameDescription
requestListRegionInstanceGroupsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
RegionInstanceGroupsClient.ListPagedResponse

list(String project, String region)

public final RegionInstanceGroupsClient.ListPagedResponse list(String project, String region)

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);
   }
 }
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

Returns
TypeDescription
RegionInstanceGroupsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupList> listCallable()

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;
     }
   }
 }
Returns
TypeDescription
UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupList>

listInstances(ListInstancesRegionInstanceGroupsRequest request)

public final RegionInstanceGroupsClient.ListInstancesPagedResponse listInstances(ListInstancesRegionInstanceGroupsRequest request)

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);
   }
 }
Parameter
NameDescription
requestListInstancesRegionInstanceGroupsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
RegionInstanceGroupsClient.ListInstancesPagedResponse

listInstances(String project, String region, String instanceGroup, RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource)

public final RegionInstanceGroupsClient.ListInstancesPagedResponse listInstances(String project, String region, String instanceGroup, RegionInstanceGroupsListInstancesRequest regionInstanceGroupsListInstancesRequestResource)

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);
   }
 }
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

instanceGroupString

Name of the regional instance group for which we want to list the instances.

regionInstanceGroupsListInstancesRequestResourceRegionInstanceGroupsListInstancesRequest

The body resource for this request

Returns
TypeDescription
RegionInstanceGroupsClient.ListInstancesPagedResponse

listInstancesCallable()

public final UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsListInstances> listInstancesCallable()

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;
     }
   }
 }
Returns
TypeDescription
UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsListInstances>

listInstancesPagedCallable()

public final UnaryCallable<ListInstancesRegionInstanceGroupsRequest,RegionInstanceGroupsClient.ListInstancesPagedResponse> listInstancesPagedCallable()

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);
   }
 }
Returns
TypeDescription
UnaryCallable<ListInstancesRegionInstanceGroupsRequest,ListInstancesPagedResponse>

listPagedCallable()

public final UnaryCallable<ListRegionInstanceGroupsRequest,RegionInstanceGroupsClient.ListPagedResponse> listPagedCallable()

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);
   }
 }
Returns
TypeDescription
UnaryCallable<ListRegionInstanceGroupsRequest,ListPagedResponse>

setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request)

public final OperationFuture<Operation,Operation> setNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request)

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();
 }
Parameter
NameDescription
requestSetNamedPortsRegionInstanceGroupRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Operation,Operation>

setNamedPortsAsync(String project, String region, String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

public final OperationFuture<Operation,Operation> setNamedPortsAsync(String project, String region, String instanceGroup, RegionInstanceGroupsSetNamedPortsRequest regionInstanceGroupsSetNamedPortsRequestResource)

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();
 }
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region scoping this request.

instanceGroupString

The name of the regional instance group where the named ports are updated.

regionInstanceGroupsSetNamedPortsRequestResourceRegionInstanceGroupsSetNamedPortsRequest

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

setNamedPortsCallable()

public final UnaryCallable<SetNamedPortsRegionInstanceGroupRequest,Operation> setNamedPortsCallable()

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();
 }
Returns
TypeDescription
UnaryCallable<SetNamedPortsRegionInstanceGroupRequest,Operation>

setNamedPortsOperationCallable()

public final OperationCallable<SetNamedPortsRegionInstanceGroupRequest,Operation,Operation> setNamedPortsOperationCallable()

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();
 }
Returns
TypeDescription
OperationCallable<SetNamedPortsRegionInstanceGroupRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()