Class RegionNetworkEndpointGroupsClient (1.28.0)

Service Description: The RegionNetworkEndpointGroups 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   NetworkEndpointGroup response =
       regionNetworkEndpointGroupsClient.get(project, region, networkEndpointGroup);
 }
 

Note: close() needs to be called on the RegionNetworkEndpointGroupsClient 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:

1. 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.
2. 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.
3. 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 RegionNetworkEndpointGroupsSettings 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
 RegionNetworkEndpointGroupsSettings regionNetworkEndpointGroupsSettings =
     RegionNetworkEndpointGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create(regionNetworkEndpointGroupsSettings);
 

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
 RegionNetworkEndpointGroupsSettings regionNetworkEndpointGroupsSettings =
     RegionNetworkEndpointGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create(regionNetworkEndpointGroupsSettings);
 

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

Constructs an instance of RegionNetworkEndpointGroupsClient with default settings.

Constructs an instance of RegionNetworkEndpointGroupsClient, 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 RegionNetworkEndpointGroupsClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionNetworkEndpointGroupsSettings).

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

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   DeleteRegionNetworkEndpointGroupRequest request =
       DeleteRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionNetworkEndpointGroupsClient.deleteAsync(request).get();
 }
 

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   Operation response =
       regionNetworkEndpointGroupsClient
           .deleteAsync(project, region, networkEndpointGroup)
           .get();
 }
 

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   DeleteRegionNetworkEndpointGroupRequest request =
       DeleteRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionNetworkEndpointGroupsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   DeleteRegionNetworkEndpointGroupRequest request =
       DeleteRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionNetworkEndpointGroupsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns the specified network endpoint 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   GetRegionNetworkEndpointGroupRequest request =
       GetRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   NetworkEndpointGroup response = regionNetworkEndpointGroupsClient.get(request);
 }
 

Returns the specified network endpoint 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   NetworkEndpointGroup response =
       regionNetworkEndpointGroupsClient.get(project, region, networkEndpointGroup);
 }
 

Returns the specified network endpoint 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   GetRegionNetworkEndpointGroupRequest request =
       GetRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<NetworkEndpointGroup> future =
       regionNetworkEndpointGroupsClient.getCallable().futureCall(request);
   // Do something.
   NetworkEndpointGroup response = future.get();
 }
 

Creates a network endpoint group in the specified project using the parameters that are included in the 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   InsertRegionNetworkEndpointGroupRequest request =
       InsertRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroupResource(NetworkEndpointGroup.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionNetworkEndpointGroupsClient.insertAsync(request).get();
 }
 

Creates a network endpoint group in the specified project using the parameters that are included in the 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   NetworkEndpointGroup networkEndpointGroupResource = NetworkEndpointGroup.newBuilder().build();
   Operation response =
       regionNetworkEndpointGroupsClient
           .insertAsync(project, region, networkEndpointGroupResource)
           .get();
 }
 

Creates a network endpoint group in the specified project using the parameters that are included in the 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   InsertRegionNetworkEndpointGroupRequest request =
       InsertRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroupResource(NetworkEndpointGroup.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionNetworkEndpointGroupsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Creates a network endpoint group in the specified project using the parameters that are included in the 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   InsertRegionNetworkEndpointGroupRequest request =
       InsertRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroupResource(NetworkEndpointGroup.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionNetworkEndpointGroupsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Retrieves the list of regional network endpoint groups available to the specified project in the given 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   ListRegionNetworkEndpointGroupsRequest request =
       ListRegionNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (NetworkEndpointGroup element :
       regionNetworkEndpointGroupsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Retrieves the list of regional network endpoint groups available to the specified project in the given 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (NetworkEndpointGroup element :
       regionNetworkEndpointGroupsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Retrieves the list of regional network endpoint groups available to the specified project in the given 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   ListRegionNetworkEndpointGroupsRequest request =
       ListRegionNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     NetworkEndpointGroupList response =
         regionNetworkEndpointGroupsClient.listCallable().call(request);
     for (NetworkEndpointGroup element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Retrieves the list of regional network endpoint groups available to the specified project in the given 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 (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   ListRegionNetworkEndpointGroupsRequest request =
       ListRegionNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<NetworkEndpointGroup> future =
       regionNetworkEndpointGroupsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (NetworkEndpointGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }