Class RegionNetworkEndpointGroupsClient (1.11.0)

Version 1.11.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class RegionNetworkEndpointGroupsClient implements BackgroundResource

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 RegionNetworkEndpointGroupsSettings regionNetworkEndpointGroupsSettings =
     RegionNetworkEndpointGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create(regionNetworkEndpointGroupsSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.

Inheritance

java.lang.Object > RegionNetworkEndpointGroupsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final RegionNetworkEndpointGroupsClient create()

Constructs an instance of RegionNetworkEndpointGroupsClient with default settings.

Returns

Type	Description
RegionNetworkEndpointGroupsClient

Exceptions

Type	Description
IOException

create(RegionNetworkEndpointGroupsSettings settings)

public static final RegionNetworkEndpointGroupsClient create(RegionNetworkEndpointGroupsSettings 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.

Parameter

Name	Description
settings	RegionNetworkEndpointGroupsSettings

Returns

Type	Description
RegionNetworkEndpointGroupsClient

Exceptions

Type	Description
IOException

create(RegionNetworkEndpointGroupsStub stub)

public static final RegionNetworkEndpointGroupsClient create(RegionNetworkEndpointGroupsStub stub)

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

Parameter

Name	Description
stub	RegionNetworkEndpointGroupsStub

Returns

Type	Description
RegionNetworkEndpointGroupsClient

Constructors

RegionNetworkEndpointGroupsClient(RegionNetworkEndpointGroupsSettings settings)

protected RegionNetworkEndpointGroupsClient(RegionNetworkEndpointGroupsSettings settings)

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.

Parameter

Name	Description
settings	RegionNetworkEndpointGroupsSettings

RegionNetworkEndpointGroupsClient(RegionNetworkEndpointGroupsStub stub)

protected RegionNetworkEndpointGroupsClient(RegionNetworkEndpointGroupsStub stub)

Parameter

Name	Description
stub	RegionNetworkEndpointGroupsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteRegionNetworkEndpointGroupRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionNetworkEndpointGroupRequest request)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String networkEndpointGroup)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String networkEndpointGroup)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String The name of the region where the network endpoint group is located. It should comply with RFC1035.
networkEndpointGroup	String The name of the network endpoint group to delete. It should comply with RFC1035.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRegionNetworkEndpointGroupRequest,Operation> deleteCallable()

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<DeleteRegionNetworkEndpointGroupRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteRegionNetworkEndpointGroupRequest,Operation,Operation> deleteOperationCallable()

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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

Type	Description
OperationCallable<DeleteRegionNetworkEndpointGroupRequest,Operation,Operation>

get(GetRegionNetworkEndpointGroupRequest request)

public final NetworkEndpointGroup get(GetRegionNetworkEndpointGroupRequest request)

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   GetRegionNetworkEndpointGroupRequest request =
       GetRegionNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   NetworkEndpointGroup response = regionNetworkEndpointGroupsClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
NetworkEndpointGroup

get(String project, String region, String networkEndpointGroup)

public final NetworkEndpointGroup get(String project, String region, String networkEndpointGroup)

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   NetworkEndpointGroup response =
       regionNetworkEndpointGroupsClient.get(project, region, networkEndpointGroup);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String The name of the region where the network endpoint group is located. It should comply with RFC1035.
networkEndpointGroup	String The name of the network endpoint group. It should comply with RFC1035.

Returns

Type	Description
NetworkEndpointGroup

getCallable()

public final UnaryCallable<GetRegionNetworkEndpointGroupRequest,NetworkEndpointGroup> getCallable()

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<GetRegionNetworkEndpointGroupRequest,NetworkEndpointGroup>

getSettings()

public final RegionNetworkEndpointGroupsSettings getSettings()

Returns

Type	Description
RegionNetworkEndpointGroupsSettings

getStub()

public RegionNetworkEndpointGroupsStub getStub()

Returns

Type	Description
RegionNetworkEndpointGroupsStub

insertAsync(InsertRegionNetworkEndpointGroupRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRegionNetworkEndpointGroupRequest request)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, NetworkEndpointGroup networkEndpointGroupResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, NetworkEndpointGroup networkEndpointGroupResource)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String The name of the region where you want to create the network endpoint group. It should comply with RFC1035.
networkEndpointGroupResource	NetworkEndpointGroup The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRegionNetworkEndpointGroupRequest,Operation> insertCallable()

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<InsertRegionNetworkEndpointGroupRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertRegionNetworkEndpointGroupRequest,Operation,Operation> insertOperationCallable()

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
OperationCallable<InsertRegionNetworkEndpointGroupRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListRegionNetworkEndpointGroupsRequest request)

public final RegionNetworkEndpointGroupsClient.ListPagedResponse list(ListRegionNetworkEndpointGroupsRequest request)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Parameter

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

Returns

Type	Description
RegionNetworkEndpointGroupsClient.ListPagedResponse

list(String project, String region)

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

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient =
     RegionNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (NetworkEndpointGroup element :
       regionNetworkEndpointGroupsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String The name of the region where the network endpoint group is located. It should comply with RFC1035.

Returns

Type	Description
RegionNetworkEndpointGroupsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionNetworkEndpointGroupsRequest,NetworkEndpointGroupList> listCallable()

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionNetworkEndpointGroupsRequest,NetworkEndpointGroupList>

listPagedCallable()

public final UnaryCallable<ListRegionNetworkEndpointGroupsRequest,RegionNetworkEndpointGroupsClient.ListPagedResponse> listPagedCallable()

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionNetworkEndpointGroupsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()