Package com.google.cloud.edgecontainer.v1 (0.13.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

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:

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of EdgeContainerSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EdgeContainerSettings edgeContainerSettings =
     EdgeContainerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EdgeContainerClient edgeContainerClient = EdgeContainerClient.create(edgeContainerSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EdgeContainerSettings edgeContainerSettings =
     EdgeContainerSettings.newBuilder().setEndpoint(myEndpoint).build();
 EdgeContainerClient edgeContainerClient = EdgeContainerClient.create(edgeContainerSettings);
 

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EdgeContainerSettings edgeContainerSettings =
     EdgeContainerSettings.newHttpJsonBuilder().build();
 EdgeContainerClient edgeContainerClient = EdgeContainerClient.create(edgeContainerSettings);
 

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

EdgeContainerClient.ListClustersFixedSizeCollection

EdgeContainerClient.ListClustersPage

EdgeContainerClient.ListClustersPagedResponse

EdgeContainerClient.ListMachinesFixedSizeCollection

EdgeContainerClient.ListMachinesPage

EdgeContainerClient.ListMachinesPagedResponse

EdgeContainerClient.ListNodePoolsFixedSizeCollection

EdgeContainerClient.ListNodePoolsPage

EdgeContainerClient.ListNodePoolsPagedResponse

EdgeContainerClient.ListVpnConnectionsFixedSizeCollection

EdgeContainerClient.ListVpnConnectionsPage

EdgeContainerClient.ListVpnConnectionsPagedResponse

EdgeContainerGrpc

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

EdgeContainerGrpc.EdgeContainerBlockingStub

A stub to allow clients to do synchronous rpc calls to service EdgeContainer.

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

EdgeContainerGrpc.EdgeContainerFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service EdgeContainer.

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

EdgeContainerGrpc.EdgeContainerImplBase

Base class for the server implementation of the service EdgeContainer.

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

EdgeContainerGrpc.EdgeContainerStub

A stub to allow clients to do asynchronous rpc calls to service EdgeContainer.

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

EdgeContainerSettings

Settings class to configure an instance of EdgeContainerClient.

The default instance has everything set to sensible defaults:

  • The default service address (edgecontainer.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getCluster to 30 seconds:


 // 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.Builder edgeContainerSettingsBuilder = EdgeContainerSettings.newBuilder();
 edgeContainerSettingsBuilder
     .getClusterSettings()
     .setRetrySettings(
         edgeContainerSettingsBuilder
             .getClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EdgeContainerSettings edgeContainerSettings = edgeContainerSettingsBuilder.build();
 

EdgeContainerSettings.Builder

Builder for EdgeContainerSettings.

Fleet

Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems.

Protobuf type google.cloud.edgecontainer.v1.Fleet

Fleet.Builder

Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems.

Protobuf type google.cloud.edgecontainer.v1.Fleet

GenerateAccessTokenRequest

Generates an access token for a cluster.

Protobuf type google.cloud.edgecontainer.v1.GenerateAccessTokenRequest

GenerateAccessTokenRequest.Builder

Generates an access token for a cluster.

Protobuf type google.cloud.edgecontainer.v1.GenerateAccessTokenRequest

GenerateAccessTokenResponse

An access token for a cluster.

Protobuf type google.cloud.edgecontainer.v1.GenerateAccessTokenResponse

GenerateAccessTokenResponse.Builder

An access token for a cluster.

Protobuf type google.cloud.edgecontainer.v1.GenerateAccessTokenResponse

GetClusterRequest

Gets a cluster.

Protobuf type google.cloud.edgecontainer.v1.GetClusterRequest

GetClusterRequest.Builder

Gets a cluster.

Protobuf type google.cloud.edgecontainer.v1.GetClusterRequest

GetMachineRequest

Gets a machine.

Protobuf type google.cloud.edgecontainer.v1.GetMachineRequest

GetMachineRequest.Builder

Gets a machine.

Protobuf type google.cloud.edgecontainer.v1.GetMachineRequest

GetNodePoolRequest

Gets a node pool.

Protobuf type google.cloud.edgecontainer.v1.GetNodePoolRequest

GetNodePoolRequest.Builder

Gets a node pool.

Protobuf type google.cloud.edgecontainer.v1.GetNodePoolRequest

GetVpnConnectionRequest

Gets a VPN connection.

Protobuf type google.cloud.edgecontainer.v1.GetVpnConnectionRequest

GetVpnConnectionRequest.Builder

Gets a VPN connection.

Protobuf type google.cloud.edgecontainer.v1.GetVpnConnectionRequest

ListClustersRequest

Lists clusters in a location.

Protobuf type google.cloud.edgecontainer.v1.ListClustersRequest

ListClustersRequest.Builder

Lists clusters in a location.

Protobuf type google.cloud.edgecontainer.v1.ListClustersRequest

ListClustersResponse

List of clusters in a location.

Protobuf type google.cloud.edgecontainer.v1.ListClustersResponse

ListClustersResponse.Builder

List of clusters in a location.

Protobuf type google.cloud.edgecontainer.v1.ListClustersResponse

ListMachinesRequest

Lists machines in a site.

Protobuf type google.cloud.edgecontainer.v1.ListMachinesRequest

ListMachinesRequest.Builder

Lists machines in a site.

Protobuf type google.cloud.edgecontainer.v1.ListMachinesRequest

ListMachinesResponse

List of machines in a site.

Protobuf type google.cloud.edgecontainer.v1.ListMachinesResponse

ListMachinesResponse.Builder

List of machines in a site.

Protobuf type google.cloud.edgecontainer.v1.ListMachinesResponse

ListNodePoolsRequest

Lists node pools in a cluster.

Protobuf type google.cloud.edgecontainer.v1.ListNodePoolsRequest

ListNodePoolsRequest.Builder

Lists node pools in a cluster.

Protobuf type google.cloud.edgecontainer.v1.ListNodePoolsRequest

ListNodePoolsResponse

List of node pools in a cluster.

Protobuf type google.cloud.edgecontainer.v1.ListNodePoolsResponse

ListNodePoolsResponse.Builder

List of node pools in a cluster.

Protobuf type google.cloud.edgecontainer.v1.ListNodePoolsResponse

ListVpnConnectionsRequest

Lists VPN connections.

Protobuf type google.cloud.edgecontainer.v1.ListVpnConnectionsRequest

ListVpnConnectionsRequest.Builder

Lists VPN connections.

Protobuf type google.cloud.edgecontainer.v1.ListVpnConnectionsRequest

ListVpnConnectionsResponse

List of VPN connections in a location.

Protobuf type google.cloud.edgecontainer.v1.ListVpnConnectionsResponse

ListVpnConnectionsResponse.Builder

List of VPN connections in a location.

Protobuf type google.cloud.edgecontainer.v1.ListVpnConnectionsResponse

LocationMetadata

Metadata for a given google.cloud.location.Location.

Protobuf type google.cloud.edgecontainer.v1.LocationMetadata

LocationMetadata.Builder

Metadata for a given google.cloud.location.Location.

Protobuf type google.cloud.edgecontainer.v1.LocationMetadata

LocationName

LocationName.Builder

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

Machine

A Google Distributed Cloud Edge machine capable of acting as a Kubernetes node.

Protobuf type google.cloud.edgecontainer.v1.Machine

Machine.Builder

A Google Distributed Cloud Edge machine capable of acting as a Kubernetes node.

Protobuf type google.cloud.edgecontainer.v1.Machine

MachineName

MachineName.Builder

Builder for projects/{project}/locations/{location}/machines/{machine}.

MaintenancePolicy

Maintenance policy configuration.

Protobuf type google.cloud.edgecontainer.v1.MaintenancePolicy

MaintenancePolicy.Builder

Maintenance policy configuration.

Protobuf type google.cloud.edgecontainer.v1.MaintenancePolicy

MaintenanceWindow

Maintenance window configuration

Protobuf type google.cloud.edgecontainer.v1.MaintenanceWindow

MaintenanceWindow.Builder

Maintenance window configuration

Protobuf type google.cloud.edgecontainer.v1.MaintenanceWindow

NodePool

A set of Kubernetes nodes in a cluster with common configuration and specification.

Protobuf type google.cloud.edgecontainer.v1.NodePool

NodePool.Builder

A set of Kubernetes nodes in a cluster with common configuration and specification.

Protobuf type google.cloud.edgecontainer.v1.NodePool

NodePool.LocalDiskEncryption

Configuration for CMEK support for edge machine local disk encryption.

Protobuf type google.cloud.edgecontainer.v1.NodePool.LocalDiskEncryption

NodePool.LocalDiskEncryption.Builder

Configuration for CMEK support for edge machine local disk encryption.

Protobuf type google.cloud.edgecontainer.v1.NodePool.LocalDiskEncryption

NodePoolName

NodePoolName.Builder

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

OperationMetadata

Long-running operation metadata for Edge Container API methods.

Protobuf type google.cloud.edgecontainer.v1.OperationMetadata

OperationMetadata.Builder

Long-running operation metadata for Edge Container API methods.

Protobuf type google.cloud.edgecontainer.v1.OperationMetadata

Quota

Represents quota for Edge Container resources.

Protobuf type google.cloud.edgecontainer.v1.Quota

Quota.Builder

Represents quota for Edge Container resources.

Protobuf type google.cloud.edgecontainer.v1.Quota

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

Protobuf type google.cloud.edgecontainer.v1.RecurringTimeWindow

RecurringTimeWindow.Builder

Represents an arbitrary window of time that recurs.

Protobuf type google.cloud.edgecontainer.v1.RecurringTimeWindow

ResourcesProto

ServiceProto

TimeWindow

Represents an arbitrary window of time.

Protobuf type google.cloud.edgecontainer.v1.TimeWindow

TimeWindow.Builder

Represents an arbitrary window of time.

Protobuf type google.cloud.edgecontainer.v1.TimeWindow

UpdateClusterRequest

Updates a cluster.

Protobuf type google.cloud.edgecontainer.v1.UpdateClusterRequest

UpdateClusterRequest.Builder

Updates a cluster.

Protobuf type google.cloud.edgecontainer.v1.UpdateClusterRequest

UpdateNodePoolRequest

Updates a node pool.

Protobuf type google.cloud.edgecontainer.v1.UpdateNodePoolRequest

UpdateNodePoolRequest.Builder

Updates a node pool.

Protobuf type google.cloud.edgecontainer.v1.UpdateNodePoolRequest

VpnConnection

A VPN connection .

Protobuf type google.cloud.edgecontainer.v1.VpnConnection

VpnConnection.Builder

A VPN connection .

Protobuf type google.cloud.edgecontainer.v1.VpnConnection

VpnConnection.Details

The created connection details.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.Details

VpnConnection.Details.Builder

The created connection details.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.Details

VpnConnection.Details.CloudRouter

The Cloud Router info.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.Details.CloudRouter

VpnConnection.Details.CloudRouter.Builder

The Cloud Router info.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.Details.CloudRouter

VpnConnection.Details.CloudVpn

The Cloud VPN info.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.Details.CloudVpn

VpnConnection.Details.CloudVpn.Builder

The Cloud VPN info.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.Details.CloudVpn

VpnConnection.VpcProject

Project detail of the VPC network.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.VpcProject

VpnConnection.VpcProject.Builder

Project detail of the VPC network.

Protobuf type google.cloud.edgecontainer.v1.VpnConnection.VpcProject

VpnConnectionName

VpnConnectionName.Builder

Builder for projects/{project}/locations/{location}/vpnConnections/{vpn_connection}.

ZoneMetadata

A Google Distributed Cloud Edge zone where edge machines are located.

Protobuf type google.cloud.edgecontainer.v1.ZoneMetadata

ZoneMetadata.Builder

A Google Distributed Cloud Edge zone where edge machines are located.

Protobuf type google.cloud.edgecontainer.v1.ZoneMetadata

Interfaces

AuthorizationOrBuilder

ClusterNetworkingOrBuilder

ClusterOrBuilder

ClusterUserOrBuilder

CreateClusterRequestOrBuilder

CreateNodePoolRequestOrBuilder

CreateVpnConnectionRequestOrBuilder

DeleteClusterRequestOrBuilder

DeleteNodePoolRequestOrBuilder

DeleteVpnConnectionRequestOrBuilder

EdgeContainerGrpc.AsyncService

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

FleetOrBuilder

GenerateAccessTokenRequestOrBuilder

GenerateAccessTokenResponseOrBuilder

GetClusterRequestOrBuilder

GetMachineRequestOrBuilder

GetNodePoolRequestOrBuilder

GetVpnConnectionRequestOrBuilder

ListClustersRequestOrBuilder

ListClustersResponseOrBuilder

ListMachinesRequestOrBuilder

ListMachinesResponseOrBuilder

ListNodePoolsRequestOrBuilder

ListNodePoolsResponseOrBuilder

ListVpnConnectionsRequestOrBuilder

ListVpnConnectionsResponseOrBuilder

LocationMetadataOrBuilder

MachineOrBuilder

MaintenancePolicyOrBuilder

MaintenanceWindowOrBuilder

NodePool.LocalDiskEncryptionOrBuilder

NodePoolOrBuilder

OperationMetadataOrBuilder

QuotaOrBuilder

RecurringTimeWindowOrBuilder

TimeWindowOrBuilder

UpdateClusterRequestOrBuilder

UpdateNodePoolRequestOrBuilder

VpnConnection.Details.CloudRouterOrBuilder

VpnConnection.Details.CloudVpnOrBuilder

VpnConnection.DetailsOrBuilder

VpnConnection.VpcProjectOrBuilder

VpnConnectionOrBuilder

ZoneMetadataOrBuilder

Enums

KmsKeyState

Represents the accessibility state of a customer-managed KMS key used for CMEK integration.

Protobuf enum google.cloud.edgecontainer.v1.KmsKeyState

VpnConnection.BgpRoutingMode

Routing mode.

Protobuf enum google.cloud.edgecontainer.v1.VpnConnection.BgpRoutingMode

VpnConnection.Details.State

The current connection state.

Protobuf enum google.cloud.edgecontainer.v1.VpnConnection.Details.State