Class GlobalNetworkEndpointGroupsClient
- java.lang.Object
-
- com.google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class GlobalNetworkEndpointGroupsClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- 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.
- 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.
- 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 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GlobalNetworkEndpointGroupsClient.ListFixedSizeCollection
static class
GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsFixedSizeCollection
static class
GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPage
static class
GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse
static class
GlobalNetworkEndpointGroupsClient.ListPage
static class
GlobalNetworkEndpointGroupsClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsSettings settings)
Constructs an instance of GlobalNetworkEndpointGroupsClient, using the given settings.protected
GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
attachNetworkEndpointsAsync(AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)
Attach a network endpoint to the specified network endpoint group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
attachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsAttachEndpointsRequest globalNetworkEndpointGroupsAttachEndpointsRequestResource)
Attach a network endpoint to the specified network endpoint group.com.google.api.gax.rpc.UnaryCallable<AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation>
attachNetworkEndpointsCallable()
Attach a network endpoint to the specified network endpoint group.com.google.api.gax.rpc.OperationCallable<AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation,Operation>
attachNetworkEndpointsOperationCallable()
Attach a network endpoint to the specified network endpoint group.boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static GlobalNetworkEndpointGroupsClient
create()
Constructs an instance of GlobalNetworkEndpointGroupsClient with default settings.static GlobalNetworkEndpointGroupsClient
create(GlobalNetworkEndpointGroupsSettings settings)
Constructs an instance of GlobalNetworkEndpointGroupsClient, using the given settings.static GlobalNetworkEndpointGroupsClient
create(GlobalNetworkEndpointGroupsStub stub)
Constructs an instance of GlobalNetworkEndpointGroupsClient, using the given stub for making calls.com.google.api.gax.longrunning.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.com.google.api.gax.longrunning.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.com.google.api.gax.rpc.UnaryCallable<DeleteGlobalNetworkEndpointGroupRequest,Operation>
deleteCallable()
Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.com.google.api.gax.rpc.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.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
detachNetworkEndpointsAsync(DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest request)
Detach the network endpoint from the specified network endpoint group.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
detachNetworkEndpointsAsync(String project, String networkEndpointGroup, GlobalNetworkEndpointGroupsDetachEndpointsRequest globalNetworkEndpointGroupsDetachEndpointsRequestResource)
Detach the network endpoint from the specified network endpoint group.com.google.api.gax.rpc.UnaryCallable<DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation>
detachNetworkEndpointsCallable()
Detach the network endpoint from the specified network endpoint group.com.google.api.gax.rpc.OperationCallable<DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest,Operation,Operation>
detachNetworkEndpointsOperationCallable()
Detach the network endpoint from the specified network endpoint group.NetworkEndpointGroup
get(GetGlobalNetworkEndpointGroupRequest request)
Returns the specified network endpoint group.NetworkEndpointGroup
get(String project, String networkEndpointGroup)
Returns the specified network endpoint group.com.google.api.gax.rpc.UnaryCallable<GetGlobalNetworkEndpointGroupRequest,NetworkEndpointGroup>
getCallable()
Returns the specified network endpoint group.GlobalNetworkEndpointGroupsSettings
getSettings()
GlobalNetworkEndpointGroupsStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertGlobalNetworkEndpointGroupRequest request)
Creates a network endpoint group in the specified project using the parameters that are included in the request.com.google.api.gax.longrunning.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.com.google.api.gax.rpc.UnaryCallable<InsertGlobalNetworkEndpointGroupRequest,Operation>
insertCallable()
Creates a network endpoint group in the specified project using the parameters that are included in the request.com.google.api.gax.rpc.OperationCallable<InsertGlobalNetworkEndpointGroupRequest,Operation,Operation>
insertOperationCallable()
Creates a network endpoint group in the specified project using the parameters that are included in the request.boolean
isShutdown()
boolean
isTerminated()
GlobalNetworkEndpointGroupsClient.ListPagedResponse
list(ListGlobalNetworkEndpointGroupsRequest request)
Retrieves the list of network endpoint groups that are located in the specified project.GlobalNetworkEndpointGroupsClient.ListPagedResponse
list(String project)
Retrieves the list of network endpoint groups that are located in the specified project.com.google.api.gax.rpc.UnaryCallable<ListGlobalNetworkEndpointGroupsRequest,NetworkEndpointGroupList>
listCallable()
Retrieves the list of network endpoint groups that are located in the specified project.GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse
listNetworkEndpoints(ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest request)
Lists the network endpoints in the specified network endpoint group.GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse
listNetworkEndpoints(String project, String networkEndpointGroup)
Lists the network endpoints in the specified network endpoint group.com.google.api.gax.rpc.UnaryCallable<ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest,NetworkEndpointGroupsListNetworkEndpoints>
listNetworkEndpointsCallable()
Lists the network endpoints in the specified network endpoint group.com.google.api.gax.rpc.UnaryCallable<ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest,GlobalNetworkEndpointGroupsClient.ListNetworkEndpointsPagedResponse>
listNetworkEndpointsPagedCallable()
Lists the network endpoints in the specified network endpoint group.com.google.api.gax.rpc.UnaryCallable<ListGlobalNetworkEndpointGroupsRequest,GlobalNetworkEndpointGroupsClient.ListPagedResponse>
listPagedCallable()
Retrieves the list of network endpoint groups that are located in the specified project.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
GlobalNetworkEndpointGroupsClient
protected GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsSettings settings) throws IOException
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.- Throws:
IOException
-
GlobalNetworkEndpointGroupsClient
protected GlobalNetworkEndpointGroupsClient(GlobalNetworkEndpointGroupsStub stub)
-
-
Method Detail
-
create
public static final GlobalNetworkEndpointGroupsClient create() throws IOException
Constructs an instance of GlobalNetworkEndpointGroupsClient with default settings.- Throws:
IOException
-
create
public static final GlobalNetworkEndpointGroupsClient create(GlobalNetworkEndpointGroupsSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final GlobalNetworkEndpointGroupsSettings getSettings()
-
getStub
public GlobalNetworkEndpointGroupsStub getStub()
-
attachNetworkEndpointsAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.networkEndpointGroup
- The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.globalNetworkEndpointGroupsAttachEndpointsRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
attachNetworkEndpointsAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
attachNetworkEndpointsOperationCallable
public final com.google.api.gax.rpc.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(); }
-
attachNetworkEndpointsCallable
public final com.google.api.gax.rpc.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(); }
-
deleteAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.networkEndpointGroup
- The name of the network endpoint group to delete. It should comply with RFC1035.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteOperationCallable
public final com.google.api.gax.rpc.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(); }
-
deleteCallable
public final com.google.api.gax.rpc.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(); }
-
detachNetworkEndpointsAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.networkEndpointGroup
- The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.globalNetworkEndpointGroupsDetachEndpointsRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
detachNetworkEndpointsAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
detachNetworkEndpointsOperationCallable
public final com.google.api.gax.rpc.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(); }
-
detachNetworkEndpointsCallable
public final com.google.api.gax.rpc.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(); }
-
get
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:
project
- Project ID for this request.networkEndpointGroup
- The name of the network endpoint group. It should comply with RFC1035.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCallable
public final com.google.api.gax.rpc.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(); }
-
insertAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.networkEndpointGroupResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertOperationCallable
public final com.google.api.gax.rpc.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(); }
-
insertCallable
public final com.google.api.gax.rpc.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(); }
-
list
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); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listCallable
public final com.google.api.gax.rpc.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; } } }
-
listNetworkEndpoints
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:
project
- Project ID for this request.networkEndpointGroup
- The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listNetworkEndpoints
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listNetworkEndpointsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listNetworkEndpointsCallable
public final com.google.api.gax.rpc.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; } } }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-