Class GlobalNetworkEndpointGroupsClient (1.65.0)

GitHub RepositoryProduct Reference

Service Description: The GlobalNetworkEndpointGroups 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   NetworkEndpointGroup response =
       globalNetworkEndpointGroupsClient.get(project, networkEndpointGroup);
 }

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

Methods
Method Description Method Variants

AttachNetworkEndpoints

Attach a network endpoint to the specified network endpoint group.

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

  • attachNetworkEndpointsAsync(AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)

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

  • attachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsAttachEndpointsRequest globalNetworkEndpointGroupsAttachEndpointsRequestResource)

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

  • attachNetworkEndpointsOperationCallable()

  • attachNetworkEndpointsCallable()

Delete

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

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

  • deleteAsync(DeleteGlobalNetworkEndpointGroupRequest request)

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

  • deleteAsync(String project, String networkEndpointGroup)

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

  • deleteOperationCallable()

  • deleteCallable()

DetachNetworkEndpoints

Detach the network endpoint from the specified network endpoint group.

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

  • detachNetworkEndpointsAsync(DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)

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

  • detachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsDetachEndpointsRequest globalNetworkEndpointGroupsDetachEndpointsRequestResource)

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

  • detachNetworkEndpointsOperationCallable()

  • detachNetworkEndpointsCallable()

Get

Returns the specified network endpoint group.

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

  • get(GetGlobalNetworkEndpointGroupRequest request)

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

  • get(String project, String networkEndpointGroup)

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

  • getCallable()

Insert

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

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

  • insertAsync(InsertGlobalNetworkEndpointGroupRequest request)

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

  • insertAsync(String project, NetworkEndpointGroup networkEndpointGroupResource)

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

  • insertOperationCallable()

  • insertCallable()

List

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

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

  • list(ListGlobalNetworkEndpointGroupsRequest request)

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

  • list(String project)

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

  • listPagedCallable()

  • listCallable()

ListNetworkEndpoints

Lists the network endpoints in the specified network endpoint group.

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

  • listNetworkEndpoints(ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest request)

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

  • listNetworkEndpoints(String project, String networkEndpointGroup)

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

  • listNetworkEndpointsPagedCallable()

  • listNetworkEndpointsCallable()

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 GlobalNetworkEndpointGroupsSettings 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
 GlobalNetworkEndpointGroupsSettings globalNetworkEndpointGroupsSettings =
     GlobalNetworkEndpointGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create(globalNetworkEndpointGroupsSettings);

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
 GlobalNetworkEndpointGroupsSettings globalNetworkEndpointGroupsSettings =
     GlobalNetworkEndpointGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
 GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create(globalNetworkEndpointGroupsSettings);

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

Inheritance

java.lang.Object > GlobalNetworkEndpointGroupsClient

Static Methods

create()

public static final GlobalNetworkEndpointGroupsClient create()

Constructs an instance of GlobalNetworkEndpointGroupsClient with default settings.

Returns
Type Description
GlobalNetworkEndpointGroupsClient
Exceptions
Type Description
IOException

create(GlobalNetworkEndpointGroupsSettings settings)

public static final GlobalNetworkEndpointGroupsClient create(GlobalNetworkEndpointGroupsSettings settings)

Constructs an instance of GlobalNetworkEndpointGroupsClient, 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 GlobalNetworkEndpointGroupsSettings
Returns
Type Description
GlobalNetworkEndpointGroupsClient
Exceptions
Type Description
IOException

create(GlobalNetworkEndpointGroupsStub stub)

public static final GlobalNetworkEndpointGroupsClient create(GlobalNetworkEndpointGroupsStub stub)

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

Parameter
Name Description
stub GlobalNetworkEndpointGroupsStub
Returns
Type Description
GlobalNetworkEndpointGroupsClient

Constructors

GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsSettings settings)

protected GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsSettings settings)

Constructs an instance of GlobalNetworkEndpointGroupsClient, 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 GlobalNetworkEndpointGroupsSettings

GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsStub stub)

protected GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsStub stub)
Parameter
Name Description
stub GlobalNetworkEndpointGroupsStub

Methods

attachNetworkEndpointsAsync(AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)

public final OperationFuture<Operation,Operation> attachNetworkEndpointsAsync(AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)

Attach a network endpoint to 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest request =
       AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest.newBuilder()
           .setGlobalNetworkEndpointGroupsAttachEndpointsRequestResource(
               GlobalNetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build())
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response =
       globalNetworkEndpointGroupsClient.attachNetworkEndpointsAsync(request).get();
 }
Parameter
Name Description
request AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

attachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsAttachEndpointsRequest globalNetworkEndpointGroupsAttachEndpointsRequestResource)

public final OperationFuture<Operation,Operation> attachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsAttachEndpointsRequest globalNetworkEndpointGroupsAttachEndpointsRequestResource)

Attach a network endpoint to 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   GlobalNetworkEndpointGroupsAttachEndpointsRequest
       globalNetworkEndpointGroupsAttachEndpointsRequestResource =
           GlobalNetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build();
   Operation response =
       globalNetworkEndpointGroupsClient
           .attachNetworkEndpointsAsync(
               project,
               networkEndpointGroup,
               globalNetworkEndpointGroupsAttachEndpointsRequestResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
networkEndpointGroup String

The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
globalNetworkEndpointGroupsAttachEndpointsRequestResource GlobalNetworkEndpointGroupsAttachEndpointsRequest

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

attachNetworkEndpointsCallable()

public final UnaryCallable<AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation> attachNetworkEndpointsCallable()

Attach a network endpoint to 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest request =
       AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest.newBuilder()
           .setGlobalNetworkEndpointGroupsAttachEndpointsRequestResource(
               GlobalNetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build())
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       globalNetworkEndpointGroupsClient.attachNetworkEndpointsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation>

attachNetworkEndpointsOperationCallable()

public final OperationCallable<AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation,Operation> attachNetworkEndpointsOperationCallable()

Attach a network endpoint to 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest request =
       AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest.newBuilder()
           .setGlobalNetworkEndpointGroupsAttachEndpointsRequestResource(
               GlobalNetworkEndpointGroupsAttachEndpointsRequest.newBuilder().build())
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       globalNetworkEndpointGroupsClient
           .attachNetworkEndpointsOperationCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation,Operation>

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(DeleteGlobalNetworkEndpointGroupRequest request)

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

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   DeleteGlobalNetworkEndpointGroupRequest request =
       DeleteGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = globalNetworkEndpointGroupsClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteGlobalNetworkEndpointGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String networkEndpointGroup)

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

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   Operation response =
       globalNetworkEndpointGroupsClient.deleteAsync(project, networkEndpointGroup).get();
 }
Parameters
Name Description
project String

Project ID for this request.
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<DeleteGlobalNetworkEndpointGroupRequest,Operation> deleteCallable()

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   DeleteGlobalNetworkEndpointGroupRequest request =
       DeleteGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       globalNetworkEndpointGroupsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteGlobalNetworkEndpointGroupRequest,Operation>

deleteOperationCallable()

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

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   DeleteGlobalNetworkEndpointGroupRequest request =
       DeleteGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       globalNetworkEndpointGroupsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteGlobalNetworkEndpointGroupRequest,Operation,Operation>

detachNetworkEndpointsAsync(DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)

public final OperationFuture<Operation,Operation> detachNetworkEndpointsAsync(DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)

Detach the network endpoint from 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest request =
       DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest.newBuilder()
           .setGlobalNetworkEndpointGroupsDetachEndpointsRequestResource(
               GlobalNetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build())
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response =
       globalNetworkEndpointGroupsClient.detachNetworkEndpointsAsync(request).get();
 }
Parameter
Name Description
request DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

detachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsDetachEndpointsRequest globalNetworkEndpointGroupsDetachEndpointsRequestResource)

public final OperationFuture<Operation,Operation> detachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsDetachEndpointsRequest globalNetworkEndpointGroupsDetachEndpointsRequestResource)

Detach the network endpoint from 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   GlobalNetworkEndpointGroupsDetachEndpointsRequest
       globalNetworkEndpointGroupsDetachEndpointsRequestResource =
           GlobalNetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build();
   Operation response =
       globalNetworkEndpointGroupsClient
           .detachNetworkEndpointsAsync(
               project,
               networkEndpointGroup,
               globalNetworkEndpointGroupsDetachEndpointsRequestResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
networkEndpointGroup String

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
globalNetworkEndpointGroupsDetachEndpointsRequestResource GlobalNetworkEndpointGroupsDetachEndpointsRequest

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

detachNetworkEndpointsCallable()

public final UnaryCallable<DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation> detachNetworkEndpointsCallable()

Detach the network endpoint from 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest request =
       DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest.newBuilder()
           .setGlobalNetworkEndpointGroupsDetachEndpointsRequestResource(
               GlobalNetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build())
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       globalNetworkEndpointGroupsClient.detachNetworkEndpointsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation>

detachNetworkEndpointsOperationCallable()

public final OperationCallable<DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation,Operation> detachNetworkEndpointsOperationCallable()

Detach the network endpoint from 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest request =
       DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest.newBuilder()
           .setGlobalNetworkEndpointGroupsDetachEndpointsRequestResource(
               GlobalNetworkEndpointGroupsDetachEndpointsRequest.newBuilder().build())
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       globalNetworkEndpointGroupsClient
           .detachNetworkEndpointsOperationCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation,Operation>

get(GetGlobalNetworkEndpointGroupRequest request)

public final NetworkEndpointGroup get(GetGlobalNetworkEndpointGroupRequest 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   GetGlobalNetworkEndpointGroupRequest request =
       GetGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .build();
   NetworkEndpointGroup response = globalNetworkEndpointGroupsClient.get(request);
 }
Parameter
Name Description
request GetGlobalNetworkEndpointGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
NetworkEndpointGroup

get(String project, String networkEndpointGroup)

public final NetworkEndpointGroup get(String project, String 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   NetworkEndpointGroup response =
       globalNetworkEndpointGroupsClient.get(project, networkEndpointGroup);
 }
Parameters
Name Description
project String

Project ID for this request.
networkEndpointGroup String

The name of the network endpoint group. It should comply with RFC1035.
Returns
Type Description
NetworkEndpointGroup

getCallable()

public final UnaryCallable<GetGlobalNetworkEndpointGroupRequest,NetworkEndpointGroup> getCallable()

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   GetGlobalNetworkEndpointGroupRequest request =
       GetGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setProject("project-309310695")
           .build();
   ApiFuture<NetworkEndpointGroup> future =
       globalNetworkEndpointGroupsClient.getCallable().futureCall(request);
   // Do something.
   NetworkEndpointGroup response = future.get();
 }
Returns
Type Description
UnaryCallable<GetGlobalNetworkEndpointGroupRequest,NetworkEndpointGroup>

getSettings()

public final GlobalNetworkEndpointGroupsSettings getSettings()
Returns
Type Description
GlobalNetworkEndpointGroupsSettings

getStub()

public GlobalNetworkEndpointGroupsStub getStub()
Returns
Type Description
GlobalNetworkEndpointGroupsStub

insertAsync(InsertGlobalNetworkEndpointGroupRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertGlobalNetworkEndpointGroupRequest 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 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   InsertGlobalNetworkEndpointGroupRequest request =
       InsertGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroupResource(NetworkEndpointGroup.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = globalNetworkEndpointGroupsClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertGlobalNetworkEndpointGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, NetworkEndpointGroup networkEndpointGroupResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, 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 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   NetworkEndpointGroup networkEndpointGroupResource = NetworkEndpointGroup.newBuilder().build();
   Operation response =
       globalNetworkEndpointGroupsClient
           .insertAsync(project, networkEndpointGroupResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
networkEndpointGroupResource NetworkEndpointGroup

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertGlobalNetworkEndpointGroupRequest,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 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   InsertGlobalNetworkEndpointGroupRequest request =
       InsertGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroupResource(NetworkEndpointGroup.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       globalNetworkEndpointGroupsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertGlobalNetworkEndpointGroupRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertGlobalNetworkEndpointGroupRequest,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 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   InsertGlobalNetworkEndpointGroupRequest request =
       InsertGlobalNetworkEndpointGroupRequest.newBuilder()
           .setNetworkEndpointGroupResource(NetworkEndpointGroup.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       globalNetworkEndpointGroupsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertGlobalNetworkEndpointGroupRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListGlobalNetworkEndpointGroupsRequest request)

public final GlobalNetworkEndpointGroupsClient.ListPagedResponse list(ListGlobalNetworkEndpointGroupsRequest request)

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

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   ListGlobalNetworkEndpointGroupsRequest request =
       ListGlobalNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (NetworkEndpointGroup element :
       globalNetworkEndpointGroupsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListGlobalNetworkEndpointGroupsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GlobalNetworkEndpointGroupsClient.ListPagedResponse

list(String project)

public final GlobalNetworkEndpointGroupsClient.ListPagedResponse list(String project)

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

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   for (NetworkEndpointGroup element :
       globalNetworkEndpointGroupsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
GlobalNetworkEndpointGroupsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListGlobalNetworkEndpointGroupsRequest,NetworkEndpointGroupList> listCallable()

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

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   ListGlobalNetworkEndpointGroupsRequest request =
       ListGlobalNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     NetworkEndpointGroupList response =
         globalNetworkEndpointGroupsClient.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<ListGlobalNetworkEndpointGroupsRequest,NetworkEndpointGroupList>

listNetworkEndpoints(ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest request)

public final GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse listNetworkEndpoints(ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest request)

Lists the network endpoints in 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest request =
       ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (NetworkEndpointWithHealthStatus element :
       globalNetworkEndpointGroupsClient.listNetworkEndpoints(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse

listNetworkEndpoints(String project, String networkEndpointGroup)

public final GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse listNetworkEndpoints(String project, String networkEndpointGroup)

Lists the network endpoints in 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   String project = "project-309310695";
   String networkEndpointGroup = "networkEndpointGroup-2120389028";
   for (NetworkEndpointWithHealthStatus element :
       globalNetworkEndpointGroupsClient
           .listNetworkEndpoints(project, networkEndpointGroup)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
networkEndpointGroup String

The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
Returns
Type Description
GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse

listNetworkEndpointsCallable()

public final UnaryCallable<ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest,NetworkEndpointGroupsListNetworkEndpoints> listNetworkEndpointsCallable()

Lists the network endpoints in 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest request =
       ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     NetworkEndpointGroupsListNetworkEndpoints response =
         globalNetworkEndpointGroupsClient.listNetworkEndpointsCallable().call(request);
     for (NetworkEndpointWithHealthStatus 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<ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest,NetworkEndpointGroupsListNetworkEndpoints>

listNetworkEndpointsPagedCallable()

public final UnaryCallable<ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest,GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse> listNetworkEndpointsPagedCallable()

Lists the network endpoints in 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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest request =
       ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setNetworkEndpointGroup("networkEndpointGroup-2120389028")
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<NetworkEndpointWithHealthStatus> future =
       globalNetworkEndpointGroupsClient.listNetworkEndpointsPagedCallable().futureCall(request);
   // Do something.
   for (NetworkEndpointWithHealthStatus element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest,ListNetworkEndpointsPagedResponse>

listPagedCallable()

public final UnaryCallable<ListGlobalNetworkEndpointGroupsRequest,GlobalNetworkEndpointGroupsClient.ListPagedResponse> listPagedCallable()

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

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 (GlobalNetworkEndpointGroupsClient globalNetworkEndpointGroupsClient =
     GlobalNetworkEndpointGroupsClient.create()) {
   ListGlobalNetworkEndpointGroupsRequest request =
       ListGlobalNetworkEndpointGroupsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<NetworkEndpointGroup> future =
       globalNetworkEndpointGroupsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (NetworkEndpointGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListGlobalNetworkEndpointGroupsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()