Class EdgeContainerClient (0.10.0)

public class EdgeContainerClient implements BackgroundResource

Service Description: EdgeContainer API provides management of Kubernetes Clusters on Google Edge Cloud deployments.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   Cluster response = edgeContainerClient.getCluster(name);
 }
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of EdgeContainerSettings 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
 EdgeContainerSettings edgeContainerSettings =
     EdgeContainerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EdgeContainerClient edgeContainerClient = EdgeContainerClient.create(edgeContainerSettings);
 

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
 EdgeContainerSettings edgeContainerSettings =
     EdgeContainerSettings.newBuilder().setEndpoint(myEndpoint).build();
 EdgeContainerClient edgeContainerClient = EdgeContainerClient.create(edgeContainerSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 EdgeContainerSettings edgeContainerSettings =
     EdgeContainerSettings.newHttpJsonBuilder().build();
 EdgeContainerClient edgeContainerClient = EdgeContainerClient.create(edgeContainerSettings);
 

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

Inheritance

java.lang.Object > EdgeContainerClient

Implements

BackgroundResource

Static Methods

create()

public static final EdgeContainerClient create()

Constructs an instance of EdgeContainerClient with default settings.

Returns
TypeDescription
EdgeContainerClient
Exceptions
TypeDescription
IOException

create(EdgeContainerSettings settings)

public static final EdgeContainerClient create(EdgeContainerSettings settings)

Constructs an instance of EdgeContainerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsEdgeContainerSettings
Returns
TypeDescription
EdgeContainerClient
Exceptions
TypeDescription
IOException

create(EdgeContainerStub stub)

public static final EdgeContainerClient create(EdgeContainerStub stub)

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

Parameter
NameDescription
stubEdgeContainerStub
Returns
TypeDescription
EdgeContainerClient

Constructors

EdgeContainerClient(EdgeContainerSettings settings)

protected EdgeContainerClient(EdgeContainerSettings settings)

Constructs an instance of EdgeContainerClient, 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
NameDescription
settingsEdgeContainerSettings

EdgeContainerClient(EdgeContainerStub stub)

protected EdgeContainerClient(EdgeContainerStub stub)
Parameter
NameDescription
stubEdgeContainerStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createClusterAsync(CreateClusterRequest request)

public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(CreateClusterRequest request)

Creates a new Cluster in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Cluster response = edgeContainerClient.createClusterAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateClusterRequest

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

Returns
TypeDescription
OperationFuture<Cluster,OperationMetadata>

createClusterAsync(LocationName parent, Cluster cluster, String clusterId)

public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(LocationName parent, Cluster cluster, String clusterId)

Creates a new Cluster in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Cluster cluster = Cluster.newBuilder().build();
   String clusterId = "clusterId561939637";
   Cluster response = edgeContainerClient.createClusterAsync(parent, cluster, clusterId).get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The parent location where this cluster will be created.

clusterCluster

Required. The cluster to create.

clusterIdString

Required. A client-specified unique identifier for the cluster.

Returns
TypeDescription
OperationFuture<Cluster,OperationMetadata>

createClusterAsync(String parent, Cluster cluster, String clusterId)

public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(String parent, Cluster cluster, String clusterId)

Creates a new Cluster in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Cluster cluster = Cluster.newBuilder().build();
   String clusterId = "clusterId561939637";
   Cluster response = edgeContainerClient.createClusterAsync(parent, cluster, clusterId).get();
 }
 
Parameters
NameDescription
parentString

Required. The parent location where this cluster will be created.

clusterCluster

Required. The cluster to create.

clusterIdString

Required. A client-specified unique identifier for the cluster.

Returns
TypeDescription
OperationFuture<Cluster,OperationMetadata>

createClusterCallable()

public final UnaryCallable<CreateClusterRequest,Operation> createClusterCallable()

Creates a new Cluster in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = edgeContainerClient.createClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateClusterRequest,Operation>

createClusterOperationCallable()

public final OperationCallable<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationCallable()

Creates a new Cluster in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, OperationMetadata> future =
       edgeContainerClient.createClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateClusterRequest,Cluster,OperationMetadata>

createNodePoolAsync(ClusterName parent, NodePool nodePool, String nodePoolId)

public final OperationFuture<NodePool,OperationMetadata> createNodePoolAsync(ClusterName parent, NodePool nodePool, String nodePoolId)

Creates a new NodePool in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   NodePool nodePool = NodePool.newBuilder().build();
   String nodePoolId = "nodePoolId1121557241";
   NodePool response =
       edgeContainerClient.createNodePoolAsync(parent, nodePool, nodePoolId).get();
 }
 
Parameters
NameDescription
parentClusterName

Required. The parent cluster where this node pool will be created.

nodePoolNodePool

Required. The node pool to create.

nodePoolIdString

Required. A client-specified unique identifier for the node pool.

Returns
TypeDescription
OperationFuture<NodePool,OperationMetadata>

createNodePoolAsync(CreateNodePoolRequest request)

public final OperationFuture<NodePool,OperationMetadata> createNodePoolAsync(CreateNodePoolRequest request)

Creates a new NodePool in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateNodePoolRequest request =
       CreateNodePoolRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setNodePoolId("nodePoolId1121557241")
           .setNodePool(NodePool.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   NodePool response = edgeContainerClient.createNodePoolAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateNodePoolRequest

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

Returns
TypeDescription
OperationFuture<NodePool,OperationMetadata>

createNodePoolAsync(String parent, NodePool nodePool, String nodePoolId)

public final OperationFuture<NodePool,OperationMetadata> createNodePoolAsync(String parent, NodePool nodePool, String nodePoolId)

Creates a new NodePool in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   NodePool nodePool = NodePool.newBuilder().build();
   String nodePoolId = "nodePoolId1121557241";
   NodePool response =
       edgeContainerClient.createNodePoolAsync(parent, nodePool, nodePoolId).get();
 }
 
Parameters
NameDescription
parentString

Required. The parent cluster where this node pool will be created.

nodePoolNodePool

Required. The node pool to create.

nodePoolIdString

Required. A client-specified unique identifier for the node pool.

Returns
TypeDescription
OperationFuture<NodePool,OperationMetadata>

createNodePoolCallable()

public final UnaryCallable<CreateNodePoolRequest,Operation> createNodePoolCallable()

Creates a new NodePool in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateNodePoolRequest request =
       CreateNodePoolRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setNodePoolId("nodePoolId1121557241")
           .setNodePool(NodePool.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       edgeContainerClient.createNodePoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateNodePoolRequest,Operation>

createNodePoolOperationCallable()

public final OperationCallable<CreateNodePoolRequest,NodePool,OperationMetadata> createNodePoolOperationCallable()

Creates a new NodePool in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateNodePoolRequest request =
       CreateNodePoolRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setNodePoolId("nodePoolId1121557241")
           .setNodePool(NodePool.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<NodePool, OperationMetadata> future =
       edgeContainerClient.createNodePoolOperationCallable().futureCall(request);
   // Do something.
   NodePool response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateNodePoolRequest,NodePool,OperationMetadata>

createVpnConnectionAsync(CreateVpnConnectionRequest request)

public final OperationFuture<VpnConnection,OperationMetadata> createVpnConnectionAsync(CreateVpnConnectionRequest request)

Creates a new VPN connection in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateVpnConnectionRequest request =
       CreateVpnConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVpnConnectionId("vpnConnectionId887330733")
           .setVpnConnection(VpnConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   VpnConnection response = edgeContainerClient.createVpnConnectionAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateVpnConnectionRequest

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

Returns
TypeDescription
OperationFuture<VpnConnection,OperationMetadata>

createVpnConnectionAsync(LocationName parent, VpnConnection vpnConnection, String vpnConnectionId)

public final OperationFuture<VpnConnection,OperationMetadata> createVpnConnectionAsync(LocationName parent, VpnConnection vpnConnection, String vpnConnectionId)

Creates a new VPN connection in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   VpnConnection vpnConnection = VpnConnection.newBuilder().build();
   String vpnConnectionId = "vpnConnectionId887330733";
   VpnConnection response =
       edgeContainerClient
           .createVpnConnectionAsync(parent, vpnConnection, vpnConnectionId)
           .get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The parent location where this vpn connection will be created.

vpnConnectionVpnConnection

Required. The VPN connection to create.

vpnConnectionIdString

Required. The VPN connection identifier.

Returns
TypeDescription
OperationFuture<VpnConnection,OperationMetadata>

createVpnConnectionAsync(String parent, VpnConnection vpnConnection, String vpnConnectionId)

public final OperationFuture<VpnConnection,OperationMetadata> createVpnConnectionAsync(String parent, VpnConnection vpnConnection, String vpnConnectionId)

Creates a new VPN connection in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   VpnConnection vpnConnection = VpnConnection.newBuilder().build();
   String vpnConnectionId = "vpnConnectionId887330733";
   VpnConnection response =
       edgeContainerClient
           .createVpnConnectionAsync(parent, vpnConnection, vpnConnectionId)
           .get();
 }
 
Parameters
NameDescription
parentString

Required. The parent location where this vpn connection will be created.

vpnConnectionVpnConnection

Required. The VPN connection to create.

vpnConnectionIdString

Required. The VPN connection identifier.

Returns
TypeDescription
OperationFuture<VpnConnection,OperationMetadata>

createVpnConnectionCallable()

public final UnaryCallable<CreateVpnConnectionRequest,Operation> createVpnConnectionCallable()

Creates a new VPN connection in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateVpnConnectionRequest request =
       CreateVpnConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVpnConnectionId("vpnConnectionId887330733")
           .setVpnConnection(VpnConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       edgeContainerClient.createVpnConnectionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateVpnConnectionRequest,Operation>

createVpnConnectionOperationCallable()

public final OperationCallable<CreateVpnConnectionRequest,VpnConnection,OperationMetadata> createVpnConnectionOperationCallable()

Creates a new VPN connection in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   CreateVpnConnectionRequest request =
       CreateVpnConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVpnConnectionId("vpnConnectionId887330733")
           .setVpnConnection(VpnConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<VpnConnection, OperationMetadata> future =
       edgeContainerClient.createVpnConnectionOperationCallable().futureCall(request);
   // Do something.
   VpnConnection response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateVpnConnectionRequest,VpnConnection,OperationMetadata>

deleteClusterAsync(ClusterName name)

public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(ClusterName name)

Deletes a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   edgeContainerClient.deleteClusterAsync(name).get();
 }
 
Parameter
NameDescription
nameClusterName

Required. The resource name of the cluster.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteClusterAsync(DeleteClusterRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(DeleteClusterRequest request)

Deletes a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setRequestId("requestId693933066")
           .build();
   edgeContainerClient.deleteClusterAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteClusterRequest

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

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteClusterAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(String name)

Deletes a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   edgeContainerClient.deleteClusterAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the cluster.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteClusterCallable()

public final UnaryCallable<DeleteClusterRequest,Operation> deleteClusterCallable()

Deletes a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = edgeContainerClient.deleteClusterCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteClusterRequest,Operation>

deleteClusterOperationCallable()

public final OperationCallable<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationCallable()

Deletes a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       edgeContainerClient.deleteClusterOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteClusterRequest,Empty,OperationMetadata>

deleteNodePoolAsync(DeleteNodePoolRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteNodePoolAsync(DeleteNodePoolRequest request)

Deletes a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteNodePoolRequest request =
       DeleteNodePoolRequest.newBuilder()
           .setName(
               NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]").toString())
           .setRequestId("requestId693933066")
           .build();
   edgeContainerClient.deleteNodePoolAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteNodePoolRequest

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

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteNodePoolAsync(NodePoolName name)

public final OperationFuture<Empty,OperationMetadata> deleteNodePoolAsync(NodePoolName name)

Deletes a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   NodePoolName name = NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]");
   edgeContainerClient.deleteNodePoolAsync(name).get();
 }
 
Parameter
NameDescription
nameNodePoolName

Required. The resource name of the node pool.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteNodePoolAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteNodePoolAsync(String name)

Deletes a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String name =
       NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]").toString();
   edgeContainerClient.deleteNodePoolAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the node pool.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteNodePoolCallable()

public final UnaryCallable<DeleteNodePoolRequest,Operation> deleteNodePoolCallable()

Deletes a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteNodePoolRequest request =
       DeleteNodePoolRequest.newBuilder()
           .setName(
               NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       edgeContainerClient.deleteNodePoolCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteNodePoolRequest,Operation>

deleteNodePoolOperationCallable()

public final OperationCallable<DeleteNodePoolRequest,Empty,OperationMetadata> deleteNodePoolOperationCallable()

Deletes a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteNodePoolRequest request =
       DeleteNodePoolRequest.newBuilder()
           .setName(
               NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       edgeContainerClient.deleteNodePoolOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteNodePoolRequest,Empty,OperationMetadata>

deleteVpnConnectionAsync(DeleteVpnConnectionRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteVpnConnectionAsync(DeleteVpnConnectionRequest request)

Deletes a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteVpnConnectionRequest request =
       DeleteVpnConnectionRequest.newBuilder()
           .setName(
               VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]").toString())
           .setRequestId("requestId693933066")
           .build();
   edgeContainerClient.deleteVpnConnectionAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteVpnConnectionRequest

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

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteVpnConnectionAsync(VpnConnectionName name)

public final OperationFuture<Empty,OperationMetadata> deleteVpnConnectionAsync(VpnConnectionName name)

Deletes a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   VpnConnectionName name = VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]");
   edgeContainerClient.deleteVpnConnectionAsync(name).get();
 }
 
Parameter
NameDescription
nameVpnConnectionName

Required. The resource name of the vpn connection.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteVpnConnectionAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteVpnConnectionAsync(String name)

Deletes a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String name = VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]").toString();
   edgeContainerClient.deleteVpnConnectionAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the vpn connection.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteVpnConnectionCallable()

public final UnaryCallable<DeleteVpnConnectionRequest,Operation> deleteVpnConnectionCallable()

Deletes a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteVpnConnectionRequest request =
       DeleteVpnConnectionRequest.newBuilder()
           .setName(
               VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       edgeContainerClient.deleteVpnConnectionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteVpnConnectionRequest,Operation>

deleteVpnConnectionOperationCallable()

public final OperationCallable<DeleteVpnConnectionRequest,Empty,OperationMetadata> deleteVpnConnectionOperationCallable()

Deletes a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   DeleteVpnConnectionRequest request =
       DeleteVpnConnectionRequest.newBuilder()
           .setName(
               VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       edgeContainerClient.deleteVpnConnectionOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteVpnConnectionRequest,Empty,OperationMetadata>

generateAccessToken(ClusterName cluster)

public final GenerateAccessTokenResponse generateAccessToken(ClusterName cluster)

Generates an access token for a Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ClusterName cluster = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   GenerateAccessTokenResponse response = edgeContainerClient.generateAccessToken(cluster);
 }
 
Parameter
NameDescription
clusterClusterName

Required. The resource name of the cluster.

Returns
TypeDescription
GenerateAccessTokenResponse

generateAccessToken(GenerateAccessTokenRequest request)

public final GenerateAccessTokenResponse generateAccessToken(GenerateAccessTokenRequest request)

Generates an access token for a Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GenerateAccessTokenRequest request =
       GenerateAccessTokenRequest.newBuilder()
           .setCluster(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   GenerateAccessTokenResponse response = edgeContainerClient.generateAccessToken(request);
 }
 
Parameter
NameDescription
requestGenerateAccessTokenRequest

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

Returns
TypeDescription
GenerateAccessTokenResponse

generateAccessToken(String cluster)

public final GenerateAccessTokenResponse generateAccessToken(String cluster)

Generates an access token for a Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String cluster = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   GenerateAccessTokenResponse response = edgeContainerClient.generateAccessToken(cluster);
 }
 
Parameter
NameDescription
clusterString

Required. The resource name of the cluster.

Returns
TypeDescription
GenerateAccessTokenResponse

generateAccessTokenCallable()

public final UnaryCallable<GenerateAccessTokenRequest,GenerateAccessTokenResponse> generateAccessTokenCallable()

Generates an access token for a Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GenerateAccessTokenRequest request =
       GenerateAccessTokenRequest.newBuilder()
           .setCluster(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   ApiFuture<GenerateAccessTokenResponse> future =
       edgeContainerClient.generateAccessTokenCallable().futureCall(request);
   // Do something.
   GenerateAccessTokenResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GenerateAccessTokenRequest,GenerateAccessTokenResponse>

getCluster(ClusterName name)

public final Cluster getCluster(ClusterName name)

Gets details of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   Cluster response = edgeContainerClient.getCluster(name);
 }
 
Parameter
NameDescription
nameClusterName

Required. The resource name of the cluster.

Returns
TypeDescription
Cluster

getCluster(GetClusterRequest request)

public final Cluster getCluster(GetClusterRequest request)

Gets details of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   Cluster response = edgeContainerClient.getCluster(request);
 }
 
Parameter
NameDescription
requestGetClusterRequest

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

Returns
TypeDescription
Cluster

getCluster(String name)

public final Cluster getCluster(String name)

Gets details of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   Cluster response = edgeContainerClient.getCluster(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the cluster.

Returns
TypeDescription
Cluster

getClusterCallable()

public final UnaryCallable<GetClusterRequest,Cluster> getClusterCallable()

Gets details of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   ApiFuture<Cluster> future = edgeContainerClient.getClusterCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetClusterRequest,Cluster>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getMachine(GetMachineRequest request)

public final Machine getMachine(GetMachineRequest request)

Gets details of a single Machine.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetMachineRequest request =
       GetMachineRequest.newBuilder()
           .setName(MachineName.of("[PROJECT]", "[LOCATION]", "[MACHINE]").toString())
           .build();
   Machine response = edgeContainerClient.getMachine(request);
 }
 
Parameter
NameDescription
requestGetMachineRequest

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

Returns
TypeDescription
Machine

getMachine(MachineName name)

public final Machine getMachine(MachineName name)

Gets details of a single Machine.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   MachineName name = MachineName.of("[PROJECT]", "[LOCATION]", "[MACHINE]");
   Machine response = edgeContainerClient.getMachine(name);
 }
 
Parameter
NameDescription
nameMachineName

Required. The resource name of the machine.

Returns
TypeDescription
Machine

getMachine(String name)

public final Machine getMachine(String name)

Gets details of a single Machine.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String name = MachineName.of("[PROJECT]", "[LOCATION]", "[MACHINE]").toString();
   Machine response = edgeContainerClient.getMachine(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the machine.

Returns
TypeDescription
Machine

getMachineCallable()

public final UnaryCallable<GetMachineRequest,Machine> getMachineCallable()

Gets details of a single Machine.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetMachineRequest request =
       GetMachineRequest.newBuilder()
           .setName(MachineName.of("[PROJECT]", "[LOCATION]", "[MACHINE]").toString())
           .build();
   ApiFuture<Machine> future = edgeContainerClient.getMachineCallable().futureCall(request);
   // Do something.
   Machine response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetMachineRequest,Machine>

getNodePool(GetNodePoolRequest request)

public final NodePool getNodePool(GetNodePoolRequest request)

Gets details of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetNodePoolRequest request =
       GetNodePoolRequest.newBuilder()
           .setName(
               NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]").toString())
           .build();
   NodePool response = edgeContainerClient.getNodePool(request);
 }
 
Parameter
NameDescription
requestGetNodePoolRequest

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

Returns
TypeDescription
NodePool

getNodePool(NodePoolName name)

public final NodePool getNodePool(NodePoolName name)

Gets details of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   NodePoolName name = NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]");
   NodePool response = edgeContainerClient.getNodePool(name);
 }
 
Parameter
NameDescription
nameNodePoolName

Required. The resource name of the node pool.

Returns
TypeDescription
NodePool

getNodePool(String name)

public final NodePool getNodePool(String name)

Gets details of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String name =
       NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]").toString();
   NodePool response = edgeContainerClient.getNodePool(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the node pool.

Returns
TypeDescription
NodePool

getNodePoolCallable()

public final UnaryCallable<GetNodePoolRequest,NodePool> getNodePoolCallable()

Gets details of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetNodePoolRequest request =
       GetNodePoolRequest.newBuilder()
           .setName(
               NodePoolName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[NODE_POOL]").toString())
           .build();
   ApiFuture<NodePool> future = edgeContainerClient.getNodePoolCallable().futureCall(request);
   // Do something.
   NodePool response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetNodePoolRequest,NodePool>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getSettings()

public final EdgeContainerSettings getSettings()
Returns
TypeDescription
EdgeContainerSettings

getStub()

public EdgeContainerStub getStub()
Returns
TypeDescription
EdgeContainerStub

getVpnConnection(GetVpnConnectionRequest request)

public final VpnConnection getVpnConnection(GetVpnConnectionRequest request)

Gets details of a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetVpnConnectionRequest request =
       GetVpnConnectionRequest.newBuilder()
           .setName(
               VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]").toString())
           .build();
   VpnConnection response = edgeContainerClient.getVpnConnection(request);
 }
 
Parameter
NameDescription
requestGetVpnConnectionRequest

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

Returns
TypeDescription
VpnConnection

getVpnConnection(VpnConnectionName name)

public final VpnConnection getVpnConnection(VpnConnectionName name)

Gets details of a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   VpnConnectionName name = VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]");
   VpnConnection response = edgeContainerClient.getVpnConnection(name);
 }
 
Parameter
NameDescription
nameVpnConnectionName

Required. The resource name of the vpn connection.

Returns
TypeDescription
VpnConnection

getVpnConnection(String name)

public final VpnConnection getVpnConnection(String name)

Gets details of a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String name = VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]").toString();
   VpnConnection response = edgeContainerClient.getVpnConnection(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the vpn connection.

Returns
TypeDescription
VpnConnection

getVpnConnectionCallable()

public final UnaryCallable<GetVpnConnectionRequest,VpnConnection> getVpnConnectionCallable()

Gets details of a single VPN connection.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   GetVpnConnectionRequest request =
       GetVpnConnectionRequest.newBuilder()
           .setName(
               VpnConnectionName.of("[PROJECT]", "[LOCATION]", "[VPN_CONNECTION]").toString())
           .build();
   ApiFuture<VpnConnection> future =
       edgeContainerClient.getVpnConnectionCallable().futureCall(request);
   // Do something.
   VpnConnection response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetVpnConnectionRequest,VpnConnection>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listClusters(ListClustersRequest request)

public final EdgeContainerClient.ListClustersPagedResponse listClusters(ListClustersRequest request)

Lists Clusters in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Cluster element : edgeContainerClient.listClusters(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListClustersRequest

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

Returns
TypeDescription
EdgeContainerClient.ListClustersPagedResponse

listClusters(LocationName parent)

public final EdgeContainerClient.ListClustersPagedResponse listClusters(LocationName parent)

Lists Clusters in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Cluster element : edgeContainerClient.listClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent location, which owns this collection of clusters.

Returns
TypeDescription
EdgeContainerClient.ListClustersPagedResponse

listClusters(String parent)

public final EdgeContainerClient.ListClustersPagedResponse listClusters(String parent)

Lists Clusters in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Cluster element : edgeContainerClient.listClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent location, which owns this collection of clusters.

Returns
TypeDescription
EdgeContainerClient.ListClustersPagedResponse

listClustersCallable()

public final UnaryCallable<ListClustersRequest,ListClustersResponse> listClustersCallable()

Lists Clusters in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListClustersResponse response = edgeContainerClient.listClustersCallable().call(request);
     for (Cluster element : response.getClustersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListClustersRequest,ListClustersResponse>

listClustersPagedCallable()

public final UnaryCallable<ListClustersRequest,EdgeContainerClient.ListClustersPagedResponse> listClustersPagedCallable()

Lists Clusters in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Cluster> future =
       edgeContainerClient.listClustersPagedCallable().futureCall(request);
   // Do something.
   for (Cluster element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListClustersRequest,ListClustersPagedResponse>

listMachines(ListMachinesRequest request)

public final EdgeContainerClient.ListMachinesPagedResponse listMachines(ListMachinesRequest request)

Lists Machines in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListMachinesRequest request =
       ListMachinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Machine element : edgeContainerClient.listMachines(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListMachinesRequest

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

Returns
TypeDescription
EdgeContainerClient.ListMachinesPagedResponse

listMachines(LocationName parent)

public final EdgeContainerClient.ListMachinesPagedResponse listMachines(LocationName parent)

Lists Machines in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Machine element : edgeContainerClient.listMachines(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent site, which owns this collection of machines.

Returns
TypeDescription
EdgeContainerClient.ListMachinesPagedResponse

listMachines(String parent)

public final EdgeContainerClient.ListMachinesPagedResponse listMachines(String parent)

Lists Machines in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Machine element : edgeContainerClient.listMachines(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent site, which owns this collection of machines.

Returns
TypeDescription
EdgeContainerClient.ListMachinesPagedResponse

listMachinesCallable()

public final UnaryCallable<ListMachinesRequest,ListMachinesResponse> listMachinesCallable()

Lists Machines in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListMachinesRequest request =
       ListMachinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListMachinesResponse response = edgeContainerClient.listMachinesCallable().call(request);
     for (Machine element : response.getMachinesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListMachinesRequest,ListMachinesResponse>

listMachinesPagedCallable()

public final UnaryCallable<ListMachinesRequest,EdgeContainerClient.ListMachinesPagedResponse> listMachinesPagedCallable()

Lists Machines in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListMachinesRequest request =
       ListMachinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Machine> future =
       edgeContainerClient.listMachinesPagedCallable().futureCall(request);
   // Do something.
   for (Machine element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListMachinesRequest,ListMachinesPagedResponse>

listNodePools(ClusterName parent)

public final EdgeContainerClient.ListNodePoolsPagedResponse listNodePools(ClusterName parent)

Lists NodePools in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   for (NodePool element : edgeContainerClient.listNodePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentClusterName

Required. The parent cluster, which owns this collection of node pools.

Returns
TypeDescription
EdgeContainerClient.ListNodePoolsPagedResponse

listNodePools(ListNodePoolsRequest request)

public final EdgeContainerClient.ListNodePoolsPagedResponse listNodePools(ListNodePoolsRequest request)

Lists NodePools in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListNodePoolsRequest request =
       ListNodePoolsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (NodePool element : edgeContainerClient.listNodePools(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListNodePoolsRequest

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

Returns
TypeDescription
EdgeContainerClient.ListNodePoolsPagedResponse

listNodePools(String parent)

public final EdgeContainerClient.ListNodePoolsPagedResponse listNodePools(String parent)

Lists NodePools in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   for (NodePool element : edgeContainerClient.listNodePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent cluster, which owns this collection of node pools.

Returns
TypeDescription
EdgeContainerClient.ListNodePoolsPagedResponse

listNodePoolsCallable()

public final UnaryCallable<ListNodePoolsRequest,ListNodePoolsResponse> listNodePoolsCallable()

Lists NodePools in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListNodePoolsRequest request =
       ListNodePoolsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListNodePoolsResponse response = edgeContainerClient.listNodePoolsCallable().call(request);
     for (NodePool element : response.getNodePoolsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListNodePoolsRequest,ListNodePoolsResponse>

listNodePoolsPagedCallable()

public final UnaryCallable<ListNodePoolsRequest,EdgeContainerClient.ListNodePoolsPagedResponse> listNodePoolsPagedCallable()

Lists NodePools in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListNodePoolsRequest request =
       ListNodePoolsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<NodePool> future =
       edgeContainerClient.listNodePoolsPagedCallable().futureCall(request);
   // Do something.
   for (NodePool element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListNodePoolsRequest,ListNodePoolsPagedResponse>

listVpnConnections(ListVpnConnectionsRequest request)

public final EdgeContainerClient.ListVpnConnectionsPagedResponse listVpnConnections(ListVpnConnectionsRequest request)

Lists VPN connections in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListVpnConnectionsRequest request =
       ListVpnConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (VpnConnection element : edgeContainerClient.listVpnConnections(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListVpnConnectionsRequest

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

Returns
TypeDescription
EdgeContainerClient.ListVpnConnectionsPagedResponse

listVpnConnections(LocationName parent)

public final EdgeContainerClient.ListVpnConnectionsPagedResponse listVpnConnections(LocationName parent)

Lists VPN connections in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (VpnConnection element : edgeContainerClient.listVpnConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent location, which owns this collection of VPN connections.

Returns
TypeDescription
EdgeContainerClient.ListVpnConnectionsPagedResponse

listVpnConnections(String parent)

public final EdgeContainerClient.ListVpnConnectionsPagedResponse listVpnConnections(String parent)

Lists VPN connections in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (VpnConnection element : edgeContainerClient.listVpnConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent location, which owns this collection of VPN connections.

Returns
TypeDescription
EdgeContainerClient.ListVpnConnectionsPagedResponse

listVpnConnectionsCallable()

public final UnaryCallable<ListVpnConnectionsRequest,ListVpnConnectionsResponse> listVpnConnectionsCallable()

Lists VPN connections in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListVpnConnectionsRequest request =
       ListVpnConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListVpnConnectionsResponse response =
         edgeContainerClient.listVpnConnectionsCallable().call(request);
     for (VpnConnection element : response.getVpnConnectionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListVpnConnectionsRequest,ListVpnConnectionsResponse>

listVpnConnectionsPagedCallable()

public final UnaryCallable<ListVpnConnectionsRequest,EdgeContainerClient.ListVpnConnectionsPagedResponse> listVpnConnectionsPagedCallable()

Lists VPN connections in a given project and location.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ListVpnConnectionsRequest request =
       ListVpnConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<VpnConnection> future =
       edgeContainerClient.listVpnConnectionsPagedCallable().futureCall(request);
   // Do something.
   for (VpnConnection element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListVpnConnectionsRequest,ListVpnConnectionsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateClusterAsync(Cluster cluster, FieldMask updateMask)

public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(Cluster cluster, FieldMask updateMask)

Updates the parameters of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Cluster response = edgeContainerClient.updateClusterAsync(cluster, updateMask).get();
 }
 
Parameters
NameDescription
clusterCluster

The updated cluster.

updateMaskFieldMask

Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
TypeDescription
OperationFuture<Cluster,OperationMetadata>

updateClusterAsync(UpdateClusterRequest request)

public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(UpdateClusterRequest request)

Updates the parameters of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Cluster response = edgeContainerClient.updateClusterAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateClusterRequest

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

Returns
TypeDescription
OperationFuture<Cluster,OperationMetadata>

updateClusterCallable()

public final UnaryCallable<UpdateClusterRequest,Operation> updateClusterCallable()

Updates the parameters of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = edgeContainerClient.updateClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateClusterRequest,Operation>

updateClusterOperationCallable()

public final OperationCallable<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationCallable()

Updates the parameters of a single Cluster.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, OperationMetadata> future =
       edgeContainerClient.updateClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateClusterRequest,Cluster,OperationMetadata>

updateNodePoolAsync(NodePool nodePool, FieldMask updateMask)

public final OperationFuture<NodePool,OperationMetadata> updateNodePoolAsync(NodePool nodePool, FieldMask updateMask)

Updates the parameters of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   NodePool nodePool = NodePool.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   NodePool response = edgeContainerClient.updateNodePoolAsync(nodePool, updateMask).get();
 }
 
Parameters
NameDescription
nodePoolNodePool

The updated node pool.

updateMaskFieldMask

Field mask is used to specify the fields to be overwritten in the NodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
TypeDescription
OperationFuture<NodePool,OperationMetadata>

updateNodePoolAsync(UpdateNodePoolRequest request)

public final OperationFuture<NodePool,OperationMetadata> updateNodePoolAsync(UpdateNodePoolRequest request)

Updates the parameters of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   UpdateNodePoolRequest request =
       UpdateNodePoolRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setNodePool(NodePool.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   NodePool response = edgeContainerClient.updateNodePoolAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateNodePoolRequest

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

Returns
TypeDescription
OperationFuture<NodePool,OperationMetadata>

updateNodePoolCallable()

public final UnaryCallable<UpdateNodePoolRequest,Operation> updateNodePoolCallable()

Updates the parameters of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   UpdateNodePoolRequest request =
       UpdateNodePoolRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setNodePool(NodePool.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       edgeContainerClient.updateNodePoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateNodePoolRequest,Operation>

updateNodePoolOperationCallable()

public final OperationCallable<UpdateNodePoolRequest,NodePool,OperationMetadata> updateNodePoolOperationCallable()

Updates the parameters of a single NodePool.

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 (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   UpdateNodePoolRequest request =
       UpdateNodePoolRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setNodePool(NodePool.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<NodePool, OperationMetadata> future =
       edgeContainerClient.updateNodePoolOperationCallable().futureCall(request);
   // Do something.
   NodePool response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateNodePoolRequest,NodePool,OperationMetadata>