Package com.google.cloud.edgecontainer.v1 (0.21.0)

A client to Distributed Cloud Edge Container API

The interfaces provided are listed below, along with usage samples.

EdgeContainerClient

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

Sample for EdgeContainerClient:


 // 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);
 }

Classes

Authorization

RBAC policy that will be applied and managed by GEC.

Protobuf type google.cloud.edgecontainer.v1.Authorization

Authorization.Builder

RBAC policy that will be applied and managed by GEC.

Protobuf type google.cloud.edgecontainer.v1.Authorization

Cluster

A Google Distributed Cloud Edge Kubernetes cluster.

Protobuf type google.cloud.edgecontainer.v1.Cluster

Cluster.Builder

A Google Distributed Cloud Edge Kubernetes cluster.

Protobuf type google.cloud.edgecontainer.v1.Cluster

ClusterName.Builder

Builder for projects/{project}/locations/{location}/clusters/{cluster}.

ClusterNetworking

Cluster-wide networking configuration.

Protobuf type google.cloud.edgecontainer.v1.ClusterNetworking

ClusterNetworking.Builder

Cluster-wide networking configuration.

Protobuf type google.cloud.edgecontainer.v1.ClusterNetworking

ClusterUser

A user principal for an RBAC policy.

Protobuf type google.cloud.edgecontainer.v1.ClusterUser

ClusterUser.Builder

A user principal for an RBAC policy.

Protobuf type google.cloud.edgecontainer.v1.ClusterUser

CreateClusterRequest

Creates a cluster.

Protobuf type google.cloud.edgecontainer.v1.CreateClusterRequest

CreateClusterRequest.Builder

Creates a cluster.

Protobuf type google.cloud.edgecontainer.v1.CreateClusterRequest

CreateNodePoolRequest

Creates a node pool.

Protobuf type google.cloud.edgecontainer.v1.CreateNodePoolRequest

CreateNodePoolRequest.Builder

Creates a node pool.

Protobuf type google.cloud.edgecontainer.v1.CreateNodePoolRequest

CreateVpnConnectionRequest

Creates a VPN connection.

Protobuf type google.cloud.edgecontainer.v1.CreateVpnConnectionRequest

CreateVpnConnectionRequest.Builder

Creates a VPN connection.

Protobuf type google.cloud.edgecontainer.v1.CreateVpnConnectionRequest

DeleteClusterRequest

Deletes a cluster.

Protobuf type google.cloud.edgecontainer.v1.DeleteClusterRequest

DeleteClusterRequest.Builder

Deletes a cluster.

Protobuf type google.cloud.edgecontainer.v1.DeleteClusterRequest

DeleteNodePoolRequest

Deletes a node pool.

Protobuf type google.cloud.edgecontainer.v1.DeleteNodePoolRequest

DeleteNodePoolRequest.Builder

Deletes a node pool.

Protobuf type google.cloud.edgecontainer.v1.DeleteNodePoolRequest

DeleteVpnConnectionRequest

Deletes a vpn connection.

Protobuf type google.cloud.edgecontainer.v1.DeleteVpnConnectionRequest

DeleteVpnConnectionRequest.Builder

Deletes a vpn connection.

Protobuf type google.cloud.edgecontainer.v1.DeleteVpnConnectionRequest

EdgeContainerClient

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EdgeContainerClient edgeContainerClient = EdgeContainerClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   Cluster response = edgeContainerClient.getCluster(name);
 }

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

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

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of 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.

EdgeContainerClient.ListClustersFixedSizeCollection

EdgeContainerClient.ListClustersPage

EdgeContainerClient.ListClustersPagedResponse

EdgeContainerClient.ListMachinesFixedSizeCollection

EdgeContainerClient.ListMachinesPage

EdgeContainerClient.ListMachinesPagedResponse

EdgeContainerClient.ListNodePoolsFixedSizeCollection

EdgeContainerClient.ListNodePoolsPage

EdgeContainerClient.ListNodePoolsPagedResponse