Class EdgeContainerClient (0.50.0)

GitHub RepositoryProduct Reference

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().

Methods
Method Description Method Variants

ListClusters

Lists Clusters in a given project and location.

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

  • listClusters(ListClustersRequest request)

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

  • listClusters(LocationName parent)

  • listClusters(String parent)

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

  • listClustersPagedCallable()

  • listClustersCallable()

GetCluster

Gets details of a single Cluster.

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

  • getCluster(GetClusterRequest request)

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

  • getCluster(ClusterName name)

  • getCluster(String name)

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

  • getClusterCallable()

CreateCluster

Creates a new Cluster in a given project and location.

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

  • createClusterAsync(CreateClusterRequest request)

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

  • createClusterAsync(LocationName parent, Cluster cluster, String clusterId)

  • createClusterAsync(String parent, Cluster cluster, String clusterId)

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

  • createClusterOperationCallable()

  • createClusterCallable()

UpdateCluster

Updates the parameters of a single Cluster.

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

  • updateClusterAsync(UpdateClusterRequest request)

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

  • updateClusterAsync(Cluster cluster, FieldMask updateMask)

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

  • updateClusterOperationCallable()

  • updateClusterCallable()

UpgradeCluster

Upgrades a single cluster.

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

  • upgradeClusterAsync(UpgradeClusterRequest request)

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

  • upgradeClusterAsync(ClusterName name, String targetVersion, UpgradeClusterRequest.Schedule schedule)

  • upgradeClusterAsync(String name, String targetVersion, UpgradeClusterRequest.Schedule schedule)

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

  • upgradeClusterOperationCallable()

  • upgradeClusterCallable()

DeleteCluster

Deletes a single Cluster.

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

  • deleteClusterAsync(DeleteClusterRequest request)

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

  • deleteClusterAsync(ClusterName name)

  • deleteClusterAsync(String name)

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

  • deleteClusterOperationCallable()

  • deleteClusterCallable()

GenerateAccessToken

Generates an access token for a Cluster.

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

  • generateAccessToken(GenerateAccessTokenRequest request)

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

  • generateAccessToken(ClusterName cluster)

  • generateAccessToken(String cluster)

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

  • generateAccessTokenCallable()

GenerateOfflineCredential

Generates an offline credential for a Cluster.

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

  • generateOfflineCredential(GenerateOfflineCredentialRequest request)

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

  • generateOfflineCredential(ClusterName cluster)

  • generateOfflineCredential(String cluster)

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

  • generateOfflineCredentialCallable()

ListNodePools

Lists NodePools in a given project and location.

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

  • listNodePools(ListNodePoolsRequest request)

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

  • listNodePools(ClusterName parent)

  • listNodePools(String parent)

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

  • listNodePoolsPagedCallable()

  • listNodePoolsCallable()

GetNodePool

Gets details of a single NodePool.

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

  • getNodePool(GetNodePoolRequest request)

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

  • getNodePool(NodePoolName name)

  • getNodePool(String name)

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

  • getNodePoolCallable()

CreateNodePool

Creates a new NodePool in a given project and location.

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

  • createNodePoolAsync(CreateNodePoolRequest request)

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

  • createNodePoolAsync(ClusterName parent, NodePool nodePool, String nodePoolId)

  • createNodePoolAsync(String parent, NodePool nodePool, String nodePoolId)

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

  • createNodePoolOperationCallable()

  • createNodePoolCallable()

UpdateNodePool

Updates the parameters of a single NodePool.

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

  • updateNodePoolAsync(UpdateNodePoolRequest request)

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

  • updateNodePoolAsync(NodePool nodePool, FieldMask updateMask)

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

  • updateNodePoolOperationCallable()

  • updateNodePoolCallable()

DeleteNodePool

Deletes a single NodePool.

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

  • deleteNodePoolAsync(DeleteNodePoolRequest request)

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

  • deleteNodePoolAsync(NodePoolName name)

  • deleteNodePoolAsync(String name)

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

  • deleteNodePoolOperationCallable()

  • deleteNodePoolCallable()

ListMachines

Lists Machines in a given project and location.

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

  • listMachines(ListMachinesRequest request)

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

  • listMachines(LocationName parent)

  • listMachines(String parent)

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

  • listMachinesPagedCallable()

  • listMachinesCallable()

GetMachine

Gets details of a single Machine.

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

  • getMachine(GetMachineRequest request)

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

  • getMachine(MachineName name)

  • getMachine(String name)

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

  • getMachineCallable()

ListVpnConnections

Lists VPN connections in a given project and location.

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

  • listVpnConnections(ListVpnConnectionsRequest request)

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

  • listVpnConnections(LocationName parent)

  • listVpnConnections(String parent)

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

  • listVpnConnectionsPagedCallable()

  • listVpnConnectionsCallable()

GetVpnConnection

Gets details of a single VPN connection.

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

  • getVpnConnection(GetVpnConnectionRequest request)

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

  • getVpnConnection(VpnConnectionName name)

  • getVpnConnection(String name)

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

  • getVpnConnectionCallable()

CreateVpnConnection

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

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

  • createVpnConnectionAsync(CreateVpnConnectionRequest request)

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

  • createVpnConnectionAsync(LocationName parent, VpnConnection vpnConnection, String vpnConnectionId)

  • createVpnConnectionAsync(String parent, VpnConnection vpnConnection, String vpnConnectionId)

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

  • createVpnConnectionOperationCallable()

  • createVpnConnectionCallable()

DeleteVpnConnection

Deletes a single VPN connection.

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

  • deleteVpnConnectionAsync(DeleteVpnConnectionRequest request)

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

  • deleteVpnConnectionAsync(VpnConnectionName name)

  • deleteVpnConnectionAsync(String name)

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

  • deleteVpnConnectionOperationCallable()

  • deleteVpnConnectionCallable()

GetServerConfig

Gets the server config.

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

  • getServerConfig(GetServerConfigRequest request)

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

  • getServerConfig(LocationName name)

  • getServerConfig(String name)

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

  • getServerConfigCallable()

ListLocations

Lists information about the supported locations for this service.

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

  • listLocations(ListLocationsRequest request)

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

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

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

  • getLocation(GetLocationRequest request)

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

  • getLocationCallable()

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

Static Methods

create()

public static final EdgeContainerClient create()

Constructs an instance of EdgeContainerClient with default settings.

Returns
Type Description
EdgeContainerClient
Exceptions
Type Description
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
Name Description
settings EdgeContainerSettings
Returns
Type Description
EdgeContainerClient
Exceptions
Type Description
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
Name Description
stub EdgeContainerStub
Returns
Type Description
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
Name Description
settings EdgeContainerSettings

EdgeContainerClient(EdgeContainerStub stub)

protected EdgeContainerClient(EdgeContainerStub stub)
Parameter
Name Description
stub EdgeContainerStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

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
Name Description
request CreateClusterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
parent LocationName

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

Required. The cluster to create.
clusterId String

Required. A client-specified unique identifier for the cluster.
Returns
Type Description
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
Name Description
parent String

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

Required. The cluster to create.
clusterId String

Required. A client-specified unique identifier for the cluster.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
parent ClusterName

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

Required. The node pool to create.
nodePoolId String

Required. A client-specified unique identifier for the node pool.
Returns
Type Description
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
Name Description
request CreateNodePoolRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
parent String

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

Required. The node pool to create.
nodePoolId String

Required. A client-specified unique identifier for the node pool.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
request CreateVpnConnectionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
parent LocationName

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

Required. The VPN connection to create.
vpnConnectionId String

Required. The VPN connection identifier.
Returns
Type Description
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
Name Description
parent String

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

Required. The VPN connection to create.
vpnConnectionId String

Required. The VPN connection identifier.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
name ClusterName

Required. The resource name of the cluster.
Returns
Type Description
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
Name Description
request DeleteClusterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
name String

Required. The resource name of the cluster.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
request DeleteNodePoolRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
name NodePoolName

Required. The resource name of the node pool.
Returns
Type Description
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
Name Description
name String

Required. The resource name of the node pool.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
request DeleteVpnConnectionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
name VpnConnectionName

Required. The resource name of the vpn connection.
Returns
Type Description
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
Name Description
name String

Required. The resource name of the vpn connection.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
cluster ClusterName

Required. The resource name of the cluster.
Returns
Type Description
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
Name Description
request GenerateAccessTokenRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
cluster String

Required. The resource name of the cluster.
Returns
Type Description
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
Type Description
UnaryCallable<GenerateAccessTokenRequest,GenerateAccessTokenResponse>

generateOfflineCredential(ClusterName cluster)

public final GenerateOfflineCredentialResponse generateOfflineCredential(ClusterName cluster)

Generates an offline credential 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]");
   GenerateOfflineCredentialResponse response =
       edgeContainerClient.generateOfflineCredential(cluster);
 }
Parameter
Name Description
cluster ClusterName

Required. The resource name of the cluster.
Returns
Type Description
GenerateOfflineCredentialResponse

generateOfflineCredential(GenerateOfflineCredentialRequest request)

public final GenerateOfflineCredentialResponse generateOfflineCredential(GenerateOfflineCredentialRequest request)

Generates an offline credential 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()) {
   GenerateOfflineCredentialRequest request =
       GenerateOfflineCredentialRequest.newBuilder()
           .setCluster(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   GenerateOfflineCredentialResponse response =
       edgeContainerClient.generateOfflineCredential(request);
 }
Parameter
Name Description
request GenerateOfflineCredentialRequest

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

generateOfflineCredential(String cluster)

public final GenerateOfflineCredentialResponse generateOfflineCredential(String cluster)

Generates an offline credential 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();
   GenerateOfflineCredentialResponse response =
       edgeContainerClient.generateOfflineCredential(cluster);
 }
Parameter
Name Description
cluster String

Required. The resource name of the cluster.
Returns
Type Description
GenerateOfflineCredentialResponse

generateOfflineCredentialCallable()

public final UnaryCallable<GenerateOfflineCredentialRequest,GenerateOfflineCredentialResponse> generateOfflineCredentialCallable()

Generates an offline credential 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()) {
   GenerateOfflineCredentialRequest request =
       GenerateOfflineCredentialRequest.newBuilder()
           .setCluster(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   ApiFuture<GenerateOfflineCredentialResponse> future =
       edgeContainerClient.generateOfflineCredentialCallable().futureCall(request);
   // Do something.
   GenerateOfflineCredentialResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<GenerateOfflineCredentialRequest,GenerateOfflineCredentialResponse>

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
Name Description
name ClusterName

Required. The resource name of the cluster.
Returns
Type Description
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
Name Description
request GetClusterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
name String

Required. The resource name of the cluster.
Returns
Type Description
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
Type Description
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
Type Description
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = edgeContainerClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = edgeContainerClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

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
Name Description
request GetMachineRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
name MachineName

Required. The resource name of the machine.
Returns
Type Description
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
Name Description
name String

Required. The resource name of the machine.
Returns
Type Description
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
Type Description
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
Name Description
request GetNodePoolRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
name NodePoolName

Required. The resource name of the node pool.
Returns
Type Description
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
Name Description
name String

Required. The resource name of the node pool.
Returns
Type Description
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
Type Description
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
Type Description
OperationsClient

getServerConfig(GetServerConfigRequest request)

public final ServerConfig getServerConfig(GetServerConfigRequest request)

Gets the server config.

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()) {
   GetServerConfigRequest request =
       GetServerConfigRequest.newBuilder()
           .setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ServerConfig response = edgeContainerClient.getServerConfig(request);
 }
Parameter
Name Description
request GetServerConfigRequest

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

getServerConfig(LocationName name)

public final ServerConfig getServerConfig(LocationName name)

Gets the server config.

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 name = LocationName.of("[PROJECT]", "[LOCATION]");
   ServerConfig response = edgeContainerClient.getServerConfig(name);
 }
Parameter
Name Description
name LocationName

Required. The name (project and location) of the server config to get, specified in the format projects/*/locations/*.
Returns
Type Description
ServerConfig

getServerConfig(String name)

public final ServerConfig getServerConfig(String name)

Gets the server config.

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 = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ServerConfig response = edgeContainerClient.getServerConfig(name);
 }
Parameter
Name Description
name String

Required. The name (project and location) of the server config to get, specified in the format projects/*/locations/*.
Returns
Type Description
ServerConfig

getServerConfigCallable()

public final UnaryCallable<GetServerConfigRequest,ServerConfig> getServerConfigCallable()

Gets the server config.

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()) {
   GetServerConfigRequest request =
       GetServerConfigRequest.newBuilder()
           .setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<ServerConfig> future =
       edgeContainerClient.getServerConfigCallable().futureCall(request);
   // Do something.
   ServerConfig response = future.get();
 }
Returns
Type Description
UnaryCallable<GetServerConfigRequest,ServerConfig>

getSettings()

public final EdgeContainerSettings getSettings()
Returns
Type Description
EdgeContainerSettings

getStub()

public EdgeContainerStub getStub()
Returns
Type Description
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
Name Description
request GetVpnConnectionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
name VpnConnectionName

Required. The resource name of the vpn connection.
Returns
Type Description
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
Name Description
name String

Required. The resource name of the vpn connection.
Returns
Type Description
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
Type Description
UnaryCallable<GetVpnConnectionRequest,VpnConnection>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
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
Name Description
request ListClustersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
parent LocationName

Required. The parent location, which owns this collection of clusters.
Returns
Type Description
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
Name Description
parent String

Required. The parent location, which owns this collection of clusters.
Returns
Type Description
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
Type Description
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
Type Description
UnaryCallable<ListClustersRequest,ListClustersPagedResponse>

listLocations(ListLocationsRequest request)

public final EdgeContainerClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : edgeContainerClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

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

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = edgeContainerClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,EdgeContainerClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       edgeContainerClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

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
Name Description
request ListMachinesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
parent LocationName

Required. The parent site, which owns this collection of machines.
Returns
Type Description
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
Name Description
parent String

Required. The parent site, which owns this collection of machines.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
parent ClusterName

Required. The parent cluster, which owns this collection of node pools.
Returns
Type Description
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
Name Description
request ListNodePoolsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
parent String

Required. The parent cluster, which owns this collection of node pools.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
request ListVpnConnectionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Name Description
parent LocationName

Required. The parent location, which owns this collection of VPN connections.
Returns
Type Description
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
Name Description
parent String

Required. The parent location, which owns this collection of VPN connections.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
cluster Cluster

The updated cluster.
updateMask FieldMask

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
Type Description
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
Name Description
request UpdateClusterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
nodePool NodePool

The updated node pool.
updateMask FieldMask

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
Type Description
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
Name Description
request UpdateNodePoolRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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
Type Description
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
Type Description
OperationCallable<UpdateNodePoolRequest,NodePool,OperationMetadata>

upgradeClusterAsync(ClusterName name, String targetVersion, UpgradeClusterRequest.Schedule schedule)

public final OperationFuture<Cluster,OperationMetadata> upgradeClusterAsync(ClusterName name, String targetVersion, UpgradeClusterRequest.Schedule schedule)

Upgrades 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]");
   String targetVersion = "targetVersion-1639412217";
   UpgradeClusterRequest.Schedule schedule = UpgradeClusterRequest.Schedule.forNumber(0);
   Cluster response =
       edgeContainerClient.upgradeClusterAsync(name, targetVersion, schedule).get();
 }
Parameters
Name Description
name ClusterName

Required. The resource name of the cluster.
targetVersion String

Required. The version the cluster is going to be upgraded to.
schedule UpgradeClusterRequest.Schedule

The schedule for the upgrade.
Returns
Type Description
OperationFuture<Cluster,OperationMetadata>

upgradeClusterAsync(UpgradeClusterRequest request)

public final OperationFuture<Cluster,OperationMetadata> upgradeClusterAsync(UpgradeClusterRequest request)

Upgrades 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()) {
   UpgradeClusterRequest request =
       UpgradeClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setTargetVersion("targetVersion-1639412217")
           .setRequestId("requestId693933066")
           .build();
   Cluster response = edgeContainerClient.upgradeClusterAsync(request).get();
 }
Parameter
Name Description
request UpgradeClusterRequest

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

upgradeClusterAsync(String name, String targetVersion, UpgradeClusterRequest.Schedule schedule)

public final OperationFuture<Cluster,OperationMetadata> upgradeClusterAsync(String name, String targetVersion, UpgradeClusterRequest.Schedule schedule)

Upgrades 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();
   String targetVersion = "targetVersion-1639412217";
   UpgradeClusterRequest.Schedule schedule = UpgradeClusterRequest.Schedule.forNumber(0);
   Cluster response =
       edgeContainerClient.upgradeClusterAsync(name, targetVersion, schedule).get();
 }
Parameters
Name Description
name String

Required. The resource name of the cluster.
targetVersion String

Required. The version the cluster is going to be upgraded to.
schedule UpgradeClusterRequest.Schedule

The schedule for the upgrade.
Returns
Type Description
OperationFuture<Cluster,OperationMetadata>

upgradeClusterCallable()

public final UnaryCallable<UpgradeClusterRequest,Operation> upgradeClusterCallable()

Upgrades 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()) {
   UpgradeClusterRequest request =
       UpgradeClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setTargetVersion("targetVersion-1639412217")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       edgeContainerClient.upgradeClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpgradeClusterRequest,Operation>

upgradeClusterOperationCallable()

public final OperationCallable<UpgradeClusterRequest,Cluster,OperationMetadata> upgradeClusterOperationCallable()

Upgrades 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()) {
   UpgradeClusterRequest request =
       UpgradeClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setTargetVersion("targetVersion-1639412217")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, OperationMetadata> future =
       edgeContainerClient.upgradeClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
Returns
Type Description
OperationCallable<UpgradeClusterRequest,Cluster,OperationMetadata>