NetworkEndpointGroupClient (Google Cloud 0.89.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.NetworkEndpointGroupClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class NetworkEndpointGroupClient
extends Object
implements BackgroundResource
```
Service Description: Creates and runs virtual machines on Google Cloud Platform.
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:
```
 
 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = NetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build();
   Operation response = networkEndpointGroupClient.attachNetworkEndpointsNetworkEndpointGroup(networkEndpointGroup, networkEndpointGroupsAttachEndpointsRequestResource);
 }
 
 
```
Note: close() needs to be called on the networkEndpointGroupClient 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 NetworkEndpointGroupSettings to create(). For example:
To customize credentials:
```
 
 NetworkEndpointGroupSettings networkEndpointGroupSettings =
     NetworkEndpointGroupSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NetworkEndpointGroupClient networkEndpointGroupClient =
     NetworkEndpointGroupClient.create(networkEndpointGroupSettings);
 
 
```
To customize the endpoint:
```
 
 NetworkEndpointGroupSettings networkEndpointGroupSettings =
     NetworkEndpointGroupSettings.newBuilder().setEndpoint(myEndpoint).build();
 NetworkEndpointGroupClient networkEndpointGroupClient =
     NetworkEndpointGroupClient.create(networkEndpointGroupSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsFixedSizeCollection`
`static class`	`NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPage`
`static class`	`NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse`
`static class`	`NetworkEndpointGroupClient.ListNetworkEndpointGroupsFixedSizeCollection`
`static class`	`NetworkEndpointGroupClient.ListNetworkEndpointGroupsPage`
`static class`	`NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse`
`static class`	`NetworkEndpointGroupClient.ListNetworkEndpointsNetworkEndpointGroupsFixedSizeCollection`
`static class`	`NetworkEndpointGroupClient.ListNetworkEndpointsNetworkEndpointGroupsPage`
`static class`	`NetworkEndpointGroupClient.ListNetworkEndpointsNetworkEndpointGroupsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NetworkEndpointGroupClient(NetworkEndpointGroupSettings settings)` Constructs an instance of NetworkEndpointGroupClient, using the given settings.
`protected`	`NetworkEndpointGroupClient(NetworkEndpointGroupStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse`	`aggregatedListNetworkEndpointGroups(AggregatedListNetworkEndpointGroupsHttpRequest request)` Retrieves the list of network endpoint groups and sorts them by zone.
`NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse`	`aggregatedListNetworkEndpointGroups(ProjectName project)` Retrieves the list of network endpoint groups and sorts them by zone.
`NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse`	`aggregatedListNetworkEndpointGroups(String project)` Retrieves the list of network endpoint groups and sorts them by zone.
`UnaryCallable<AggregatedListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupAggregatedList>`	`aggregatedListNetworkEndpointGroupsCallable()` Retrieves the list of network endpoint groups and sorts them by zone.
`UnaryCallable<AggregatedListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse>`	`aggregatedListNetworkEndpointGroupsPagedCallable()` Retrieves the list of network endpoint groups and sorts them by zone.
`Operation`	`attachNetworkEndpointsNetworkEndpointGroup(AttachNetworkEndpointsNetworkEndpointGroupHttpRequest request)` Attach a list of network endpoints to the specified network endpoint group.
`Operation`	`attachNetworkEndpointsNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource)` Attach a list of network endpoints to the specified network endpoint group.
`Operation`	`attachNetworkEndpointsNetworkEndpointGroup(String networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource)` Attach a list of network endpoints to the specified network endpoint group.
`UnaryCallable<AttachNetworkEndpointsNetworkEndpointGroupHttpRequest,Operation>`	`attachNetworkEndpointsNetworkEndpointGroupCallable()` Attach a list of network endpoints to the specified network endpoint group.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static NetworkEndpointGroupClient`	`create()` Constructs an instance of NetworkEndpointGroupClient with default settings.
`static NetworkEndpointGroupClient`	`create(NetworkEndpointGroupSettings settings)` Constructs an instance of NetworkEndpointGroupClient, using the given settings.
`static NetworkEndpointGroupClient`	`create(NetworkEndpointGroupStub stub)` Constructs an instance of NetworkEndpointGroupClient, using the given stub for making calls.
`Operation`	`deleteNetworkEndpointGroup(DeleteNetworkEndpointGroupHttpRequest request)` Deletes the specified network endpoint group.
`Operation`	`deleteNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup)` Deletes the specified network endpoint group.
`Operation`	`deleteNetworkEndpointGroup(String networkEndpointGroup)` Deletes the specified network endpoint group.
`UnaryCallable<DeleteNetworkEndpointGroupHttpRequest,Operation>`	`deleteNetworkEndpointGroupCallable()` Deletes the specified network endpoint group.
`Operation`	`detachNetworkEndpointsNetworkEndpointGroup(DetachNetworkEndpointsNetworkEndpointGroupHttpRequest request)` Detach a list of network endpoints from the specified network endpoint group.
`Operation`	`detachNetworkEndpointsNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource)` Detach a list of network endpoints from the specified network endpoint group.
`Operation`	`detachNetworkEndpointsNetworkEndpointGroup(String networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource)` Detach a list of network endpoints from the specified network endpoint group.
`UnaryCallable<DetachNetworkEndpointsNetworkEndpointGroupHttpRequest,Operation>`	`detachNetworkEndpointsNetworkEndpointGroupCallable()` Detach a list of network endpoints from the specified network endpoint group.
`NetworkEndpointGroup`	`getNetworkEndpointGroup(GetNetworkEndpointGroupHttpRequest request)` Returns the specified network endpoint group.
`NetworkEndpointGroup`	`getNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup)` Returns the specified network endpoint group.
`NetworkEndpointGroup`	`getNetworkEndpointGroup(String networkEndpointGroup)` Returns the specified network endpoint group.
`UnaryCallable<GetNetworkEndpointGroupHttpRequest,NetworkEndpointGroup>`	`getNetworkEndpointGroupCallable()` Returns the specified network endpoint group.
`NetworkEndpointGroupSettings`	`getSettings()`
`NetworkEndpointGroupStub`	`getStub()`
`Operation`	`insertNetworkEndpointGroup(InsertNetworkEndpointGroupHttpRequest request)` Creates a network endpoint group in the specified project using the parameters that are included in the request.
`Operation`	`insertNetworkEndpointGroup(ProjectZoneName zone, NetworkEndpointGroup networkEndpointGroupResource)` Creates a network endpoint group in the specified project using the parameters that are included in the request.
`Operation`	`insertNetworkEndpointGroup(String zone, NetworkEndpointGroup networkEndpointGroupResource)` Creates a network endpoint group in the specified project using the parameters that are included in the request.
`UnaryCallable<InsertNetworkEndpointGroupHttpRequest,Operation>`	`insertNetworkEndpointGroupCallable()` Creates a network endpoint group in the specified project using the parameters that are included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse`	`listNetworkEndpointGroups(ListNetworkEndpointGroupsHttpRequest request)` Retrieves the list of network endpoint groups that are located in the specified project and zone.
`NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse`	`listNetworkEndpointGroups(ProjectZoneName zone)` Retrieves the list of network endpoint groups that are located in the specified project and zone.
`NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse`	`listNetworkEndpointGroups(String zone)` Retrieves the list of network endpoint groups that are located in the specified project and zone.
`UnaryCallable<ListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupList>`	`listNetworkEndpointGroupsCallable()` Retrieves the list of network endpoint groups that are located in the specified project and zone.
`UnaryCallable<ListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse>`	`listNetworkEndpointGroupsPagedCallable()` Retrieves the list of network endpoint groups that are located in the specified project and zone.
`NetworkEndpointGroupClient.ListNetworkEndpointsNetworkEndpointGroupsPagedResponse`	`listNetworkEndpointsNetworkEndpointGroups(ListNetworkEndpointsNetworkEndpointGroupsHttpRequest request)` Lists the network endpoints in the specified network endpoint group.
`NetworkEndpointGroupClient.ListNetworkEndpointsNetworkEndpointGroupsPagedResponse`	`listNetworkEndpointsNetworkEndpointGroups(ProjectZoneNetworkEndpointGroupName networkEndpointGroup, NetworkEndpointGroupsListEndpointsRequest networkEndpointGroupsListEndpointsRequestResource)` Lists the network endpoints in the specified network endpoint group.
`NetworkEndpointGroupClient.ListNetworkEndpointsNetworkEndpointGroupsPagedResponse`	`listNetworkEndpointsNetworkEndpointGroups(String networkEndpointGroup, NetworkEndpointGroupsListEndpointsRequest networkEndpointGroupsListEndpointsRequestResource)` Lists the network endpoints in the specified network endpoint group.
`UnaryCallable<ListNetworkEndpointsNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupsListNetworkEndpoints>`	`listNetworkEndpointsNetworkEndpointGroupsCallable()` Lists the network endpoints in the specified network endpoint group.
`UnaryCallable<ListNetworkEndpointsNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupClient.ListNetworkEndpointsNetworkEndpointGroupsPagedResponse>`	`listNetworkEndpointsNetworkEndpointGroupsPagedCallable()` Lists the network endpoints in the specified network endpoint group.
`void`	`shutdown()`
`void`	`shutdownNow()`
`TestPermissionsResponse`	`testIamPermissionsNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupResourceName resource, TestPermissionsRequest testPermissionsRequestResource)` Returns permissions that a caller has on the specified resource.
`TestPermissionsResponse`	`testIamPermissionsNetworkEndpointGroup(String resource, TestPermissionsRequest testPermissionsRequestResource)` Returns permissions that a caller has on the specified resource.
`TestPermissionsResponse`	`testIamPermissionsNetworkEndpointGroup(TestIamPermissionsNetworkEndpointGroupHttpRequest request)` Returns permissions that a caller has on the specified resource.
`UnaryCallable<TestIamPermissionsNetworkEndpointGroupHttpRequest,TestPermissionsResponse>`	`testIamPermissionsNetworkEndpointGroupCallable()` Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkEndpointGroupClient
```
protected NetworkEndpointGroupClient(NetworkEndpointGroupSettings settings)
                              throws IOException
```
Constructs an instance of NetworkEndpointGroupClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

NetworkEndpointGroupClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected NetworkEndpointGroupClient(NetworkEndpointGroupStub stub)

Method Detail

create

public static final NetworkEndpointGroupClient create()
                                               throws IOException

Constructs an instance of NetworkEndpointGroupClient with default settings.

Throws:: IOException

create
```
public static final NetworkEndpointGroupClient create(NetworkEndpointGroupSettings settings)
                                               throws IOException
```
Constructs an instance of NetworkEndpointGroupClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final NetworkEndpointGroupClient create(NetworkEndpointGroupStub stub)

Constructs an instance of NetworkEndpointGroupClient, using the given stub for making calls. This is for advanced usage - prefer to use NetworkEndpointGroupSettings}.

getSettings

public final NetworkEndpointGroupSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public NetworkEndpointGroupStub getStub()

aggregatedListNetworkEndpointGroups

@BetaApi
public final NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse aggregatedListNetworkEndpointGroups(ProjectName project)

Retrieves the list of network endpoint groups and sorts them by zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (NetworkEndpointGroupsScopedList element : networkEndpointGroupClient.aggregatedListNetworkEndpointGroups(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: ApiException - if the remote call fails

aggregatedListNetworkEndpointGroups

@BetaApi
public final NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse aggregatedListNetworkEndpointGroups(String project)

Retrieves the list of network endpoint groups and sorts them by zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (NetworkEndpointGroupsScopedList element : networkEndpointGroupClient.aggregatedListNetworkEndpointGroups(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: ApiException - if the remote call fails

aggregatedListNetworkEndpointGroups

@BetaApi
public final NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse aggregatedListNetworkEndpointGroups(AggregatedListNetworkEndpointGroupsHttpRequest request)

Retrieves the list of network endpoint groups and sorts them by zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListNetworkEndpointGroupsHttpRequest request = AggregatedListNetworkEndpointGroupsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (NetworkEndpointGroupsScopedList element : networkEndpointGroupClient.aggregatedListNetworkEndpointGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

aggregatedListNetworkEndpointGroupsPagedCallable

@BetaApi
public final UnaryCallable<AggregatedListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupClient.AggregatedListNetworkEndpointGroupsPagedResponse> aggregatedListNetworkEndpointGroupsPagedCallable()

Retrieves the list of network endpoint groups and sorts them by zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListNetworkEndpointGroupsHttpRequest request = AggregatedListNetworkEndpointGroupsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListNetworkEndpointGroupsPagedResponse> future = networkEndpointGroupClient.aggregatedListNetworkEndpointGroupsPagedCallable().futureCall(request);
   // Do something
   for (NetworkEndpointGroupsScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListNetworkEndpointGroupsCallable

@BetaApi
public final UnaryCallable<AggregatedListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupAggregatedList> aggregatedListNetworkEndpointGroupsCallable()

Retrieves the list of network endpoint groups and sorts them by zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListNetworkEndpointGroupsHttpRequest request = AggregatedListNetworkEndpointGroupsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     NetworkEndpointGroupAggregatedList response = networkEndpointGroupClient.aggregatedListNetworkEndpointGroupsCallable().call(request);
     for (NetworkEndpointGroupsScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

attachNetworkEndpointsNetworkEndpointGroup

@BetaApi
public final Operation attachNetworkEndpointsNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup,
                                                                           NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource)

Attach a list of network endpoints to the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = NetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build();
   Operation response = networkEndpointGroupClient.attachNetworkEndpointsNetworkEndpointGroup(networkEndpointGroup, networkEndpointGroupsAttachEndpointsRequestResource);
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.; networkEndpointGroupsAttachEndpointsRequestResource -
Throws:: ApiException - if the remote call fails

attachNetworkEndpointsNetworkEndpointGroup

@BetaApi
public final Operation attachNetworkEndpointsNetworkEndpointGroup(String networkEndpointGroup,
                                                                           NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource)

Attach a list of network endpoints to the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = NetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build();
   Operation response = networkEndpointGroupClient.attachNetworkEndpointsNetworkEndpointGroup(networkEndpointGroup.toString(), networkEndpointGroupsAttachEndpointsRequestResource);
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.; networkEndpointGroupsAttachEndpointsRequestResource -
Throws:: ApiException - if the remote call fails

attachNetworkEndpointsNetworkEndpointGroup

@BetaApi
public final Operation attachNetworkEndpointsNetworkEndpointGroup(AttachNetworkEndpointsNetworkEndpointGroupHttpRequest request)

Attach a list of network endpoints to the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = NetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build();
   AttachNetworkEndpointsNetworkEndpointGroupHttpRequest request = AttachNetworkEndpointsNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .setNetworkEndpointGroupsAttachEndpointsRequestResource(networkEndpointGroupsAttachEndpointsRequestResource)
     .build();
   Operation response = networkEndpointGroupClient.attachNetworkEndpointsNetworkEndpointGroup(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

attachNetworkEndpointsNetworkEndpointGroupCallable

@BetaApi
public final UnaryCallable<AttachNetworkEndpointsNetworkEndpointGroupHttpRequest,Operation> attachNetworkEndpointsNetworkEndpointGroupCallable()

Attach a list of network endpoints to the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = NetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build();
   AttachNetworkEndpointsNetworkEndpointGroupHttpRequest request = AttachNetworkEndpointsNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .setNetworkEndpointGroupsAttachEndpointsRequestResource(networkEndpointGroupsAttachEndpointsRequestResource)
     .build();
   ApiFuture<Operation> future = networkEndpointGroupClient.attachNetworkEndpointsNetworkEndpointGroupCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

deleteNetworkEndpointGroup

@BetaApi
public final Operation deleteNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup)

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   Operation response = networkEndpointGroupClient.deleteNetworkEndpointGroup(networkEndpointGroup);
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group to delete. It should comply with RFC1035.
Throws:: ApiException - if the remote call fails

deleteNetworkEndpointGroup

@BetaApi
public final Operation deleteNetworkEndpointGroup(String networkEndpointGroup)

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   Operation response = networkEndpointGroupClient.deleteNetworkEndpointGroup(networkEndpointGroup.toString());
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group to delete. It should comply with RFC1035.
Throws:: ApiException - if the remote call fails

deleteNetworkEndpointGroup

@BetaApi
public final Operation deleteNetworkEndpointGroup(DeleteNetworkEndpointGroupHttpRequest request)

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   DeleteNetworkEndpointGroupHttpRequest request = DeleteNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .build();
   Operation response = networkEndpointGroupClient.deleteNetworkEndpointGroup(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteNetworkEndpointGroupCallable

@BetaApi
public final UnaryCallable<DeleteNetworkEndpointGroupHttpRequest,Operation> deleteNetworkEndpointGroupCallable()

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   DeleteNetworkEndpointGroupHttpRequest request = DeleteNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .build();
   ApiFuture<Operation> future = networkEndpointGroupClient.deleteNetworkEndpointGroupCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

detachNetworkEndpointsNetworkEndpointGroup

@BetaApi
public final Operation detachNetworkEndpointsNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup,
                                                                           NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource)

Detach a list of network endpoints from the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource = NetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build();
   Operation response = networkEndpointGroupClient.detachNetworkEndpointsNetworkEndpointGroup(networkEndpointGroup, networkEndpointGroupsDetachEndpointsRequestResource);
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.; networkEndpointGroupsDetachEndpointsRequestResource -
Throws:: ApiException - if the remote call fails

detachNetworkEndpointsNetworkEndpointGroup

@BetaApi
public final Operation detachNetworkEndpointsNetworkEndpointGroup(String networkEndpointGroup,
                                                                           NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource)

Detach a list of network endpoints from the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource = NetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build();
   Operation response = networkEndpointGroupClient.detachNetworkEndpointsNetworkEndpointGroup(networkEndpointGroup.toString(), networkEndpointGroupsDetachEndpointsRequestResource);
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.; networkEndpointGroupsDetachEndpointsRequestResource -
Throws:: ApiException - if the remote call fails

detachNetworkEndpointsNetworkEndpointGroup

@BetaApi
public final Operation detachNetworkEndpointsNetworkEndpointGroup(DetachNetworkEndpointsNetworkEndpointGroupHttpRequest request)

Detach a list of network endpoints from the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource = NetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build();
   DetachNetworkEndpointsNetworkEndpointGroupHttpRequest request = DetachNetworkEndpointsNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .setNetworkEndpointGroupsDetachEndpointsRequestResource(networkEndpointGroupsDetachEndpointsRequestResource)
     .build();
   Operation response = networkEndpointGroupClient.detachNetworkEndpointsNetworkEndpointGroup(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

detachNetworkEndpointsNetworkEndpointGroupCallable

@BetaApi
public final UnaryCallable<DetachNetworkEndpointsNetworkEndpointGroupHttpRequest,Operation> detachNetworkEndpointsNetworkEndpointGroupCallable()

Detach a list of network endpoints from the specified network endpoint group.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource = NetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build();
   DetachNetworkEndpointsNetworkEndpointGroupHttpRequest request = DetachNetworkEndpointsNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .setNetworkEndpointGroupsDetachEndpointsRequestResource(networkEndpointGroupsDetachEndpointsRequestResource)
     .build();
   ApiFuture<Operation> future = networkEndpointGroupClient.detachNetworkEndpointsNetworkEndpointGroupCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getNetworkEndpointGroup

@BetaApi
public final NetworkEndpointGroup getNetworkEndpointGroup(ProjectZoneNetworkEndpointGroupName networkEndpointGroup)

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

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroup response = networkEndpointGroupClient.getNetworkEndpointGroup(networkEndpointGroup);
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group. It should comply with RFC1035.
Throws:: ApiException - if the remote call fails

getNetworkEndpointGroup

@BetaApi
public final NetworkEndpointGroup getNetworkEndpointGroup(String networkEndpointGroup)

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

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneNetworkEndpointGroupName networkEndpointGroup = ProjectZoneNetworkEndpointGroupName.of("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   NetworkEndpointGroup response = networkEndpointGroupClient.getNetworkEndpointGroup(networkEndpointGroup.toString());
 }

Parameters:: networkEndpointGroup - The name of the network endpoint group. It should comply with RFC1035.
Throws:: ApiException - if the remote call fails

getNetworkEndpointGroup

@BetaApi
public final NetworkEndpointGroup getNetworkEndpointGroup(GetNetworkEndpointGroupHttpRequest request)

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

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   GetNetworkEndpointGroupHttpRequest request = GetNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .build();
   NetworkEndpointGroup response = networkEndpointGroupClient.getNetworkEndpointGroup(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getNetworkEndpointGroupCallable

@BetaApi
public final UnaryCallable<GetNetworkEndpointGroupHttpRequest,NetworkEndpointGroup> getNetworkEndpointGroupCallable()

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

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedNetworkEndpointGroup = ProjectZoneNetworkEndpointGroupName.format("[PROJECT]", "[ZONE]", "[NETWORK_ENDPOINT_GROUP]");
   GetNetworkEndpointGroupHttpRequest request = GetNetworkEndpointGroupHttpRequest.newBuilder()
     .setNetworkEndpointGroup(formattedNetworkEndpointGroup)
     .build();
   ApiFuture<NetworkEndpointGroup> future = networkEndpointGroupClient.getNetworkEndpointGroupCallable().futureCall(request);
   // Do something
   NetworkEndpointGroup response = future.get();
 }

insertNetworkEndpointGroup

@BetaApi
public final Operation insertNetworkEndpointGroup(ProjectZoneName zone,
                                                           NetworkEndpointGroup networkEndpointGroupResource)

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   NetworkEndpointGroup networkEndpointGroupResource = NetworkEndpointGroup.newBuilder().build();
   Operation response = networkEndpointGroupClient.insertNetworkEndpointGroup(zone, networkEndpointGroupResource);
 }

Parameters:: zone - The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.; networkEndpointGroupResource - Represents a collection of network endpoints.
Throws:: ApiException - if the remote call fails

insertNetworkEndpointGroup

@BetaApi
public final Operation insertNetworkEndpointGroup(String zone,
                                                           NetworkEndpointGroup networkEndpointGroupResource)

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   NetworkEndpointGroup networkEndpointGroupResource = NetworkEndpointGroup.newBuilder().build();
   Operation response = networkEndpointGroupClient.insertNetworkEndpointGroup(zone.toString(), networkEndpointGroupResource);
 }

Parameters:: zone - The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.; networkEndpointGroupResource - Represents a collection of network endpoints.
Throws:: ApiException - if the remote call fails

insertNetworkEndpointGroup

@BetaApi
public final Operation insertNetworkEndpointGroup(InsertNetworkEndpointGroupHttpRequest request)

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   NetworkEndpointGroup networkEndpointGroupResource = NetworkEndpointGroup.newBuilder().build();
   InsertNetworkEndpointGroupHttpRequest request = InsertNetworkEndpointGroupHttpRequest.newBuilder()
     .setZone(formattedZone)
     .setNetworkEndpointGroupResource(networkEndpointGroupResource)
     .build();
   Operation response = networkEndpointGroupClient.insertNetworkEndpointGroup(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

insertNetworkEndpointGroupCallable

@BetaApi
public final UnaryCallable<InsertNetworkEndpointGroupHttpRequest,Operation> insertNetworkEndpointGroupCallable()

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   NetworkEndpointGroup networkEndpointGroupResource = NetworkEndpointGroup.newBuilder().build();
   InsertNetworkEndpointGroupHttpRequest request = InsertNetworkEndpointGroupHttpRequest.newBuilder()
     .setZone(formattedZone)
     .setNetworkEndpointGroupResource(networkEndpointGroupResource)
     .build();
   ApiFuture<Operation> future = networkEndpointGroupClient.insertNetworkEndpointGroupCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

listNetworkEndpointGroups

@BetaApi
public final NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse listNetworkEndpointGroups(ProjectZoneName zone)

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (NetworkEndpointGroup element : networkEndpointGroupClient.listNetworkEndpointGroups(zone).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: zone - The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Throws:: ApiException - if the remote call fails

listNetworkEndpointGroups

@BetaApi
public final NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse listNetworkEndpointGroups(String zone)

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (NetworkEndpointGroup element : networkEndpointGroupClient.listNetworkEndpointGroups(zone.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: zone - The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Throws:: ApiException - if the remote call fails

listNetworkEndpointGroups

@BetaApi
public final NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse listNetworkEndpointGroups(ListNetworkEndpointGroupsHttpRequest request)

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListNetworkEndpointGroupsHttpRequest request = ListNetworkEndpointGroupsHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   for (NetworkEndpointGroup element : networkEndpointGroupClient.listNetworkEndpointGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

listNetworkEndpointGroupsPagedCallable

@BetaApi
public final UnaryCallable<ListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupClient.ListNetworkEndpointGroupsPagedResponse> listNetworkEndpointGroupsPagedCallable()

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListNetworkEndpointGroupsHttpRequest request = ListNetworkEndpointGroupsHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   ApiFuture<ListNetworkEndpointGroupsPagedResponse> future = networkEndpointGroupClient.listNetworkEndpointGroupsPagedCallable().futureCall(request);
   // Do something
   for (NetworkEndpointGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listNetworkEndpointGroupsCallable

@BetaApi
public final UnaryCallable<ListNetworkEndpointGroupsHttpRequest,NetworkEndpointGroupList> listNetworkEndpointGroupsCallable()

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Sample code:


 try (NetworkEndpointGroupClient networkEndpointGroupClient = NetworkEndpointGroupClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListNetworkEndpointGroupsHttpRequest request = ListNetworkEndpointGroupsHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   while (true) {
     NetworkEndpointGroupList response = networkEndpointGroupClient.listNetworkEndpointGroupsCallable().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;
     }
   }
 }