Package google.cloud.edgecontainer.v1alpha

Index

EdgeContainer

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

CreateCluster

rpc CreateCluster(CreateClusterRequest) returns (Operation)

Creates a new Cluster in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateNodePool

rpc CreateNodePool(CreateNodePoolRequest) returns (Operation)

Creates a new NodePool in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateVpnConnection

rpc CreateVpnConnection(CreateVpnConnectionRequest) returns (Operation)

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

Deletes a single Cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteNodePool

rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation)

Deletes a single NodePool.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteVpnConnection

rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation)

Deletes a single VPN connection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DisableZonalService

rpc DisableZonalService(DisableZonalServiceRequest) returns (Operation)

DisableZonalService removes service access from the zone.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
EnableZonalProject

rpc EnableZonalProject(EnableZonalProjectRequest) returns (Operation)

EnableZonalProject enables consumer project on the zone.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
EnableZonalService

rpc EnableZonalService(EnableZonalServiceRequest) returns (Operation)

EnableZonalService enables a service on a zone.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GenerateAccessToken

rpc GenerateAccessToken(GenerateAccessTokenRequest) returns (GenerateAccessTokenResponse)

Generates an access token for a Cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GenerateOfflineCredential

rpc GenerateOfflineCredential(GenerateOfflineCredentialRequest) returns (GenerateOfflineCredentialResponse)

Generates an offline credential for a Cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

Gets details of a single Cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetMachine

rpc GetMachine(GetMachineRequest) returns (Machine)

Gets details of a single Machine.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetNodePool

rpc GetNodePool(GetNodePoolRequest) returns (NodePool)

Gets details of a single NodePool.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetServerConfig

rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig)

Gets the server config.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetVpnConnection

rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection)

Gets details of a single VPN connection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetZonalProject

rpc GetZonalProject(GetZonalProjectRequest) returns (ZonalProject)

GetZonalProject gets the ZonalProject.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetZonalService

rpc GetZonalService(GetZonalServiceRequest) returns (ZonalService)

Get EnabledZonalService gets the enabled service details.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetZone

rpc GetZone(GetZoneRequest) returns (Zone)

Gets details of a single Zone on which the parent organization is enabled.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListClusters

rpc ListClusters(ListClustersRequest) returns (ListClustersResponse)

Lists Clusters in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListMachines

rpc ListMachines(ListMachinesRequest) returns (ListMachinesResponse)

Lists Machines in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListNodePools

rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse)

Lists NodePools in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListVpnConnections

rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse)

Lists VPN connections in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListZonalProjects

rpc ListZonalProjects(ListZonalProjectsRequest) returns (ListZonalProjectsResponse)

Lists ZonalProjects on the zone.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListZonalServices

rpc ListZonalServices(ListZonalServicesRequest) returns (ListZonalServicesResponse)

Lists ZonalServices in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListZones

rpc ListZones(ListZonesRequest) returns (ListZonesResponse)

Lists Zones on which the parent organization is enabled.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateCluster

rpc UpdateCluster(UpdateClusterRequest) returns (Operation)

Updates the parameters of a single Cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateNodePool

rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation)

Updates the parameters of a single NodePool.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpgradeCluster

rpc UpgradeCluster(UpgradeClusterRequest) returns (Operation)

Upgrades a single cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Authorization

RBAC policy that will be applied and managed by GEC.

Fields
admin_users

ClusterUser

Required. User that will be granted the cluster-admin role on the cluster, providing full access to the cluster. Currently, this is a singular field, but will be expanded to allow multiple admins in the future.

ChannelConfig

Configuration for a release channel.

Fields
default_version

string

Output only. Default version for this release channel, e.g.: "1.4.0".

Cluster

A Google Distributed Cloud Edge Kubernetes cluster.

Fields
name

string

Required. The resource name of the cluster.
create_time

Timestamp

Output only. The time when the cluster was created.
update_time

Timestamp

Output only. The time when the cluster was last updated.
labels

map<string, string>

Labels associated with this resource.
fleet

Fleet

Required. Fleet configuration.
networking

ClusterNetworking

Required. Cluster-wide networking configuration.
authorization

Authorization

Required. Immutable. RBAC policy that will be applied and managed by GEC.
default_max_pods_per_node

int32

Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used.
endpoint

string

Output only. The IP address of the Kubernetes API server.
port

int32

Output only. The port number of the Kubernetes API server.
cluster_ca_certificate

string

Output only. The PEM-encoded public certificate of the cluster's CA.
maintenance_policy

MaintenancePolicy

Optional. Cluster-wide maintenance policy configuration.
control_plane_version

string

Output only. The control plane release version
node_version

string

Output only. The lowest release version among all worker nodes. This field can be empty if the cluster does not have any worker nodes.
control_plane

ControlPlane

Optional. The configuration of the cluster control plane.
system_addons_config

SystemAddonsConfig

Optional. The configuration of the system add-ons.
external_load_balancer_ipv4_address_pools[]

string

Optional. IPv4 address pools for cluster data plane external load balancing.
control_plane_encryption

ControlPlaneEncryption

Optional. Remote control plane disk encryption options. This field is only used when enabling CMEK support.
status

Status

Output only. The current status of the cluster.
maintenance_events[]

MaintenanceEvent

Output only. All the maintenance events scheduled for the cluster, including the ones ongoing, planned for the future and done in the past (up to 90 days).
target_version

string

Optional. The target cluster version. For example: "1.5.0".
release_channel

ReleaseChannel

Optional. The release channel a cluster is subscribed to.
survivability_config

SurvivabilityConfig

Optional. Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. Note: This only applies to local control plane clusters.
external_load_balancer_ipv6_address_pools[]

string

Optional. IPv6 address pools for cluster data plane external load balancing.
connection_state

ConnectionState

Output only. The current connection state of the cluster.
external_load_balancer_address_pools[]

ExternalLoadBalancerPool

Optional. External load balancer pools for cluster.
zone_storage_encryption

ZoneStorageEncryption

Optional. The zone storage encryption configuration

ConnectionState

ConnectionState holds the current connection state from the cluster to Google.

Fields
state

State

Output only. The current connection state.
update_time

Timestamp

Output only. The time when the connection state was last changed.

State

The connection state.

Enums
STATE_UNSPECIFIED Unknown connection state.
DISCONNECTED This cluster is currently disconnected from Google.
CONNECTED This cluster is currently connected to Google.
CONNECTED_AND_SYNCING This cluster is currently connected to Google, but may have recently reconnected after a disconnection. It is still syncing back.

ControlPlane

Configuration of the cluster control plane.

Fields

Union field config.

config can be only one of the following:
remote

Remote

Remote control plane configuration.
local

Local

Local control plane configuration.

Warning: Local control plane clusters must be created in their own project. Local control plane clusters cannot coexist in the same project with any other type of clusters, including non-GDCE clusters. Mixing local control plane GDCE clusters with any other type of clusters in the same project can result in data loss.

Local

Configuration specific to clusters with a control plane hosted locally.

Warning: Local control plane clusters must be created in their own project. Local control plane clusters cannot coexist in the same project with any other type of clusters, including non-GDCE clusters. Mixing local control plane GDCE clusters with any other type of clusters in the same project can result in data loss.

Fields
node_location

string

Name of the Google Distributed Cloud Edge zones where this node pool will be created. For example: us-central1-edge-customer-a.
node_count

int32

The number of nodes to serve as replicas of the Control Plane.
machine_filter

string

Only machines matching this filter will be allowed to host control plane nodes. The filtering language accepts strings like "name=", and is documented here: AIP-160.
shared_deployment_policy

SharedDeploymentPolicy

Policy configuration about how user applications are deployed.
control_plane_node_storage_schema

string

Optional. Name for the storage schema of control plane nodes.

Warning: Configurable node local storage schema feature is an experimental feature, and is not recommended for general use in production clusters/nodepools.

Remote

This type has no fields.

Configuration specific to clusters with a control plane hosted remotely.

SharedDeploymentPolicy

Represents the policy configuration about how user applications are deployed.

Enums
SHARED_DEPLOYMENT_POLICY_UNSPECIFIED Unspecified.
ALLOWED User applications can be deployed both on control plane and worker nodes.
DISALLOWED User applications can not be deployed on control plane nodes and can only be deployed on worker nodes.

ControlPlaneEncryption

Configuration for Customer-managed KMS key support for control plane nodes.

Fields
kms_key

string

Optional. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.
kms_key_active_version

string

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set.
kms_key_state

KmsKeyState

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.
kms_status

Status

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.
resource_state

ResourceState

Output only. The current resource state associated with the cmek.

ExternalLoadBalancerPool

External load balancer pool with custom config such as name, manual/auto assign, non-overlapping ipv4 and optional ipv6 address range.

Fields
address_pool

string

Optional. Name of the external load balancer pool.
ipv4_range[]

string

Required. Non-overlapping IPv4 address range of the external load balancer pool.
ipv6_range[]

string

Optional. Non-overlapping IPv6 address range of the external load balancer pool.
avoid_buggy_ips

bool

Optional. If true, the pool omits IP addresses ending in .0 and .255. Some network hardware drops traffic to these special addresses. Its default value is false.
manual_assign

bool

Optional. If true, addresses in this pool are not automatically assigned to Kubernetes Services. If true, an IP address in this pool is used only when it is specified explicitly by a service. Its default value is false.

MaintenanceEvent

A Maintenance Event is an operation that could cause temporary disruptions to the cluster workloads, including Google-driven or user-initiated cluster upgrades, user-initiated cluster configuration changes that require restarting nodes, etc.

Fields
uuid

string

Output only. UUID of the maintenance event.
target_version

string

Output only. The target version of the cluster.
operation

string

Output only. The operation for running the maintenance event. Specified in the format projects/*/locations/*/operations/*. If the maintenance event is split into multiple operations (e.g. due to maintenance windows), the latest one is recorded.
type

Type

Output only. The type of the maintenance event.
schedule

Schedule

Output only. The schedule of the maintenance event.
state

State

Output only. The state of the maintenance event.
create_time

Timestamp

Output only. The time when the maintenance event request was created.
start_time

Timestamp

Output only. The time when the maintenance event started.
end_time

Timestamp

Output only. The time when the maintenance event ended, either successfully or not. If the maintenance event is split into multiple maintenance windows, end_time is only updated when the whole flow ends.
update_time

Timestamp

Output only. The time when the maintenance event message was updated.

Schedule

Indicates when the maintenance event should be performed.

Enums
SCHEDULE_UNSPECIFIED Unspecified.
IMMEDIATELY Immediately after receiving the request.

State

Indicates the maintenance event state.

Enums
STATE_UNSPECIFIED Unspecified.
RECONCILING The maintenance event is ongoing. The cluster might be unusable.
SUCCEEDED The maintenance event succeeded.
FAILED The maintenance event failed.

Type

Indicates the maintenance event type.

Enums
TYPE_UNSPECIFIED Unspecified.
USER_INITIATED_UPGRADE Upgrade initiated by users.
GOOGLE_DRIVEN_UPGRADE Upgrade driven by Google.

ReleaseChannel

The release channel a cluster is subscribed to.

Enums
RELEASE_CHANNEL_UNSPECIFIED Unspecified release channel. This will default to the REGULAR channel.
NONE No release channel.
REGULAR Regular release channel.

Status

Indicates the status of the cluster.

Enums
STATUS_UNSPECIFIED Status unknown.
PROVISIONING The cluster is being created.
RUNNING The cluster is created and fully usable.
DELETING The cluster is being deleted.
ERROR The status indicates that some errors occurred while reconciling/deleting the cluster.
RECONCILING The cluster is undergoing some work such as version upgrades, etc.

SurvivabilityConfig

Configuration of the cluster survivability, e.g., for the case when network connectivity is lost.

Fields
offline_reboot_ttl

Duration

Optional. Time period that allows the cluster nodes to be rebooted and become functional without network connectivity to Google. The default 0 means not allowed. The maximum is 7 days.

SystemAddonsConfig

Config that customers are allowed to define for GDCE system add-ons.

Fields
ingress

Ingress

Optional. Config for Ingress.
vm_service_config

VMServiceConfig

Optional. Config for VM Service.

Ingress

Config for the Ingress add-on which allows customers to create an Ingress object to manage external access to the servers in a cluster. The add-on consists of istiod and istio-ingress.

Fields
disabled

bool

Optional. Whether Ingress is disabled.
ipv4_vip

string

Optional. Ingress VIP.

VMServiceConfig

VMServiceConfig defines the configuration for GDCE VM Service.

Fields
vmm_enabled

bool

Optional. Whether VMM is enabled.

ZoneStorageEncryption

Configuration for Zone Storage CMEK Support

Fields
kms_key

string

Optional. The Cloud KMS Key
kms_key_active_version

string

Output only. The Cloud KMS CryptoKeyVersion currently used for encryption/decryption
resource_state

ResourceState

Output only. The current resource state of the CMEK

ClusterNetworking

Cluster-wide networking configuration.

Fields
cluster_ipv4_cidr_blocks[]

string

Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation.
services_ipv4_cidr_blocks[]

string

Required. All services in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation.

ClusterUser

A user principal for an RBAC policy.

Fields
username

string

Required. An active Google username.

ConfigData

Config data holds all the config related data for the zone.

Fields
available_external_lb_pools_ipv4[]

string

list of available v4 ip pools for external loadbalancer
available_external_lb_pools_ipv6[]

string

list of available v6 ip pools for external loadbalancer

CreateClusterRequest

Creates a cluster.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.clusters.create
cluster_id

string

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

Cluster

Required. The cluster to create.
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

CreateNodePoolRequest

Creates a node pool.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.nodePools.create
node_pool_id

string

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

NodePool

Required. The node pool to create.
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

CreateVpnConnectionRequest

Creates a VPN connection.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.vpnConnections.create
vpn_connection_id

string

Required. The VPN connection identifier.
vpn_connection

VpnConnection

Required. The VPN connection to create.
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

DeleteClusterRequest

Deletes a cluster.

Fields
name

string

Required. The resource name of the cluster.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.clusters.delete
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

DeleteNodePoolRequest

Deletes a node pool.

Fields
name

string

Required. The resource name of the node pool.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.nodePools.delete
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

DeleteVpnConnectionRequest

Deletes a vpn connection.

Fields
name

string

Required. The resource name of the vpn connection.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.vpnConnections.delete
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

DisableZonalServiceRequest

Disable ZonalService Request. The API will remove access for the service producers.

Fields
name

string

Required. The name of the service to disable.

Authorization requires the following IAM permission on the specified resource name:

  • iam.permissions.none
request_id

string

Optional. Idempotent request UUID.

EnableZonalProjectRequest

Enables a consumer project (corresponding to the cloud consumer project) on zone(s).

Fields
parent

string

Required. The parent zone where the project will be created
zonal_project_id

string

Required. Specified project_id of the consumer project to be enabled.
zonal_project

ZonalProject

Required. The consumer project to be enabled.
request_id

string

Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

EnableZonalProjectResponse

Response message for enabling a zonal project.

Fields
zonal_project

ZonalProject

The enabled zonal project.

EnableZonalServiceRequest

Enable ZonalService Request. The API will configure access for the service producers on the cluster to create service resources.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • iam.permissions.none
zonal_service_id

string

Optional. Specified zonal_service_id.
zonal_service

ZonalService

Required. The service to create.
request_id

string

Optional. Idempotent request UUID.

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.

Fields
project

string

Required. The name of the Fleet host project where this cluster will be registered.

Project names are formatted as projects/<project-number>.
membership

string

Output only. The name of the managed Hub Membership resource associated to this cluster.

Membership names are formatted as projects/<project-number>/locations/global/membership/<cluster-id>.

GenerateAccessTokenRequest

Generates an access token for a cluster.

Fields
cluster

string

Required. The resource name of the cluster.

Authorization requires the following IAM permission on the specified resource cluster:

  • edgecontainer.clusters.get

GenerateAccessTokenResponse

An access token for a cluster.

Fields
access_token

string

Output only. Access token to authenticate to k8s api-server.
expire_time

Timestamp

Output only. Timestamp at which the token will expire.

GenerateOfflineCredentialRequest

Generates an offline credential(offline) for a cluster.

Fields
cluster

string

Required. The resource name of the cluster.

Authorization requires the following IAM permission on the specified resource cluster:

  • edgecontainer.clusters.get

GenerateOfflineCredentialResponse

An offline credential for a cluster.

Fields
client_certificate

string

Output only. Client certificate to authenticate to k8s api-server.
client_key

string

Output only. Client private key to authenticate to k8s api-server.
user_id

string

Output only. Client's identity.
expire_time

Timestamp

Output only. Timestamp at which this credential will expire.

GetClusterRequest

Gets a cluster.

Fields
name

string

Required. The resource name of the cluster.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.clusters.get

GetMachineRequest

Gets a machine.

Fields
name

string

Required. The resource name of the machine.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.machines.get

GetNodePoolRequest

Gets a node pool.

Fields
name

string

Required. The resource name of the node pool.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.nodePools.get

GetServerConfigRequest

Gets the server config.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.serverConfig.get

GetVpnConnectionRequest

Gets a VPN connection.

Fields
name

string

Required. The resource name of the vpn connection.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.vpnConnections.get

GetZonalProjectRequest

Gets a zonal project resource.

Fields
name

string

Required. The canonical resource name of the zonal project. E.g. organizations/*/locations/*/zonalProjects/*

Authorization requires the following IAM permission on the specified resource name:

  • iam.permissions.none

GetZonalServiceRequest

Get ZonalService Request.

Fields
name

string

Required. The resource name of the service.

GetZoneRequest

Gets a zone.

Fields
name

string

Required. The canonical resource name of the zone. E.g. organizations/*/locations/*/zone/*

Authorization requires the following IAM permission on the specified resource name:

  • iam.permissions.none

KmsKeyState

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

Enums
KMS_KEY_STATE_UNSPECIFIED Unspecified.
KMS_KEY_STATE_KEY_AVAILABLE The key is available for use, and dependent resources should be accessible.
KMS_KEY_STATE_KEY_UNAVAILABLE The key is unavailable for an unspecified reason. Dependent resources may be inaccessible.

ListClustersRequest

Lists clusters in a location.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.clusters.list
page_size

int32

The maximum number of resources to list.
page_token

string

A page token received from previous list request. A page token received from previous list request.
filter

string

Only resources matching this filter will be listed.
order_by

string

Specifies the order in which resources will be listed.

ListClustersResponse

List of clusters in a location.

Fields
clusters[]

Cluster

Clusters in the location.
next_page_token

string

A token to retrieve next page of results.
unreachable[]

string

Locations that could not be reached.

ListMachinesRequest

Lists machines in a site.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.machines.list
page_size

int32

The maximum number of resources to list.
page_token

string

A page token received from previous list request.
filter

string

Only resources matching this filter will be listed.
order_by

string

Specifies the order in which resources will be listed.

ListMachinesResponse

List of machines in a site.

Fields
machines[]

Machine

Machines in the site.
next_page_token

string

A token to retrieve next page of results.
unreachable[]

string

Locations that could not be reached.

ListNodePoolsRequest

Lists node pools in a cluster.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.nodePools.list
page_size

int32

The maximum number of resources to list.
page_token

string

A page token received from previous list request.
filter

string

Only resources matching this filter will be listed.
order_by

string

Specifies the order in which resources will be listed.

ListNodePoolsResponse

List of node pools in a cluster.

Fields
node_pools[]

NodePool

Node pools in the cluster.
next_page_token

string

A token to retrieve next page of results.
unreachable[]

string

Locations that could not be reached.

ListVpnConnectionsRequest

Lists VPN connections.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.vpnConnections.list
page_size

int32

The maximum number of resources to list.
page_token

string

A page token received from previous list request.
filter

string

Only resources matching this filter will be listed.
order_by

string

Specifies the order in which resources will be listed.

ListVpnConnectionsResponse

List of VPN connections in a location.

Fields
vpn_connections[]

VpnConnection

VpnConnections in the location.
next_page_token

string

A token to retrieve next page of results.
unreachable[]

string

Locations that could not be reached.

ListZonalProjectsRequest

Lists consumer projects in an organization.

Fields
parent

string

Required. The parent zone where the project will be created.

Authorization requires the following IAM permission on the specified resource parent:

  • iam.permissions.none
page_size

int32

Optional. The maximum number of resources to list.
page_token

string

Optional. A page token received from previous list request.
filter

string

Optional. Only resources matching this filter will be listed.
order_by

string

Optional. Specifies the order in which resources will be listed. Order by fields for the result.

ListZonalProjectsResponse

List of consumer projects in a organization response.

Fields
zonal_projects[]

ZonalProject

Clusters in the location.
next_page_token

string

A token to retrieve next page of results.
unreachable[]

string

zones that could not be reached.

ListZonalServicesRequest

List ZonalServices Request.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • iam.permissions.none
page_size

int32

Optional. The maximum number of resources to list.
page_token

string

Optional. A page token received from previous list request.
filter

string

Optional. Only resources matching this filter will be listed.
order_by

string

Optional. Specifies the order in which resources will be listed. Order by fields for the result.

ListZonalServicesResponse

List ZonalServices Response.

Fields
zonal_services[]

ZonalService

ZonalServices in the location.
next_page_token

string

A token to retrieve next page of results.
unreachable[]

string

Locations that could not be reached.

ListZonesRequest

Lists zones on which the parent organization is enabled.

Fields
parent

string

Required. The parent organization and location.

Authorization requires the following IAM permission on the specified resource parent:

  • iam.permissions.none
page_size

int32

Optional. The maximum number of items to return.
page_token

string

Optional. The next_page_token value returned from a previous List request, if any.
filter

string

Optional. Only resources matching this filter will be listed.
order_by

string

Optional. Specifies the order in which resources will be listed.

ListZonesResponse

Response message for listing zones.

Fields
zones[]

Zone

A list of zones matching the request.
next_page_token

string

A token to retrieve next page of results.
unreachable[]

string

Locations that could not be reached.

LocationMetadata

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

Fields
available_zones

map<string, ZoneMetadata>

The set of available Google Distributed Cloud Edge zones in the location. The map is keyed by the lowercase ID of each zone.

Machine

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

Fields
name

string

Required. The resource name of the machine.
create_time

Timestamp

Output only. The time when the node pool was created.
update_time

Timestamp

Output only. The time when the node pool was last updated.
labels

map<string, string>

Labels associated with this resource.
hosted_node

string

Canonical resource name of the node that this machine is responsible for hosting e.g. projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node}, Or empty if the machine is not assigned to assume the role of a node.

For control plane nodes hosted on edge machines, this will return the following format: "projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}".
zone

string

The Google Distributed Cloud Edge zone of this machine.
version

string

Output only. The software version of the machine.
disabled

bool

Output only. Whether the machine is disabled. If disabled, the machine is unable to enter service.
status

Status

Output only. The current status of the machine.
purpose

Purpose

The type of cluster the machine is used for.

Purpose

Machine purpose can be either VIRTUALIZED_WORKLOAD or BAREMETAL_CLUSTER.

Enums
PURPOSE_UNSPECIFIED Unspecified purpose.
VIRTUALIZED_WORKLOAD Machine is used for virtual workload.
BAREMETAL_CLUSTER Machine is used for a baremetal user cluster.

Status

Indicates the status of the machine.

Enums
STATUS_UNSPECIFIED Status unknown.
READY The machine is ready to host a node. This is the default.
DISABLED_FOR_REPAIR The machine has been disabled for repair by adding 1 or more disable claims.

MaintenanceExclusionWindow

Represents a maintenance exclusion window.

Fields
window

TimeWindow

Optional. The time window.
id

string

Optional. A unique (per cluster) id for the window.

MaintenancePolicy

Maintenance policy configuration.

Fields
window

MaintenanceWindow

Specifies the maintenance window in which maintenance may be performed.
maintenance_exclusions[]

MaintenanceExclusionWindow

Optional. Exclusions to automatic maintenance. Non-emergency maintenance should not occur in these windows. Each exclusion has a unique name and may be active or expired. The max number of maintenance exclusions allowed at a given time is 3.

MaintenanceWindow

Maintenance window configuration

Fields
recurring_window

RecurringTimeWindow

Configuration of a recurring maintenance window.

NodePool

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

Fields
name

string

Required. The resource name of the node pool.
create_time

Timestamp

Output only. The time when the node pool was created.
update_time

Timestamp

Output only. The time when the node pool was last updated.
labels

map<string, string>

Labels associated with this resource.
node_location

string

Name of the Google Distributed Cloud Edge zone where this node pool will be created. For example: us-central1-edge-customer-a.
node_count

int32

Required. The number of nodes in the pool.
machine_filter

string

Only machines matching this filter will be allowed to join the node pool. The filtering language accepts strings like "name=", and is documented in more detail in AIP-160.
local_disk_encryption

LocalDiskEncryption

Optional. Local disk encryption options. This field is only used when enabling CMEK support.
node_version

string

Output only. The lowest release version among all worker nodes.
node_config

NodeConfig

Optional. Configuration for each node in the NodePool

LocalDiskEncryption

Configuration for CMEK support for edge machine local disk encryption.

Fields
kms_key

string

Optional. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting node local disks. If not specified, a Google-managed key will be used instead.
kms_key_active_version

string

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting node local disks. Only applicable if kms_key is set.
kms_key_state

KmsKeyState

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.
kms_status

Status

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.
resource_state

ResourceState

Output only. The current resource state associated with the cmek.

NodeConfig

Configuration for each node in the NodePool

Fields
labels

map<string, string>

Optional. The Kubernetes node labels
node_storage_schema

string

Optional. Name for the storage schema of worker nodes.

Warning: Configurable node local storage schema feature is an experimental feature, and is not recommended for general use in production clusters/nodepools.

OperationMetadata

Long-running operation metadata for Edge Container API methods.

Fields
create_time

Timestamp

The time the operation was created.
end_time

Timestamp

The time the operation finished running.
target

string

Server-defined resource path for the target of the operation.
verb

string

The verb executed by the operation.
status_message

string

Human-readable status of the operation, if any.
requested_cancellation

bool

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

API version used to start the operation.
warnings[]

string

Warnings that do not block the operation, but still hold relevant information for the end user to receive.
status_reason

StatusReason

Machine-readable status of the operation, if any.

StatusReason

Indicates the reason for the status of the operation.

Enums
STATUS_REASON_UNSPECIFIED Reason unknown.
UPGRADE_PAUSED The cluster upgrade is currently paused.

Quota

Represents quota for Edge Container resources.

Fields
metric

string

Name of the quota metric.
limit

double

Quota limit for this metric.
usage

double

Current usage of this metric.

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

Fields
window

TimeWindow

The window of the first recurrence.
recurrence

string

An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window recurs. They go on for the span of time between the start and end time.

ResourceState

Represents if the resource is in lock down state or pending.

Enums
RESOURCE_STATE_UNSPECIFIED Default value.
RESOURCE_STATE_LOCK_DOWN The resource is in LOCK DOWN state.
RESOURCE_STATE_LOCK_DOWN_PENDING The resource is pending lock down.

ServerConfig

Server configuration for supported versions and release channels.

Fields
channels

map<string, ChannelConfig>

Output only. Mapping from release channel to channel config.
versions[]

Version

Output only. Supported versions, e.g.: ["1.4.0", "1.5.0"].
default_version

string

Output only. Default version, e.g.: "1.4.0".

TimeWindow

Represents an arbitrary window of time.

Fields
start_time

Timestamp

The time that the window first starts.
end_time

Timestamp

The time that the window ends. The end time must take place after the start time.

UpdateClusterRequest

Updates a cluster.

Fields
update_mask

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.
cluster

Cluster

The updated cluster.

Authorization requires the following IAM permission on the specified resource cluster:

  • edgecontainer.clusters.update
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

UpdateNodePoolRequest

Updates a node pool.

Fields
update_mask

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.
node_pool

NodePool

The updated node pool.

Authorization requires the following IAM permission on the specified resource nodePool:

  • edgecontainer.nodePools.update
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

UpgradeClusterRequest

Upgrades a cluster.

Fields
name

string

Required. The resource name of the cluster.

Authorization requires the following IAM permission on the specified resource name:

  • edgecontainer.clusters.upgrade
target_version

string

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

Schedule

The schedule for the upgrade.
request_id

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

Schedule

Represents the schedule about when the cluster is going to be upgraded.

Enums
SCHEDULE_UNSPECIFIED Unspecified. The default is to upgrade the cluster immediately which is the only option today.
IMMEDIATELY The cluster is going to be upgraded immediately after receiving the request.

Version

Version of a cluster.

Fields
name

string

Output only. Name of the version, e.g.: "1.4.0".

VpnConnection

A VPN connection .

Fields
name

string

Required. The resource name of VPN connection
create_time

Timestamp

Output only. The time when the VPN connection was created.
update_time

Timestamp

Output only. The time when the VPN connection was last updated.
labels

map<string, string>

Labels associated with this resource.
nat_gateway_ip

string

NAT gateway IP, or WAN IP address. If a customer has multiple NAT IPs, the customer needs to configure NAT such that only one external IP maps to the GMEC Anthos cluster. This is empty if NAT is not used.
bgp_routing_mode
(deprecated)

BgpRoutingMode

Dynamic routing mode of the VPC network, regional or global.
cluster

string

The canonical Cluster name to connect to. It is in the form of projects/{project}/locations/{location}/clusters/{cluster}.
vpc

string

The network ID of VPC to connect to.
vpc_project

VpcProject

Optional. Project detail of the VPC network. Required if VPC is in a different project than the cluster project.
enable_high_availability

bool

Whether this VPN connection has HA enabled on cluster side. If enabled, when creating VPN connection we will attempt to use 2 ANG floating IPs.
router

string

Optional. The VPN connection Cloud Router name.
details

Details

Output only. The created connection details.

BgpRoutingMode

Routing mode.

Enums
BGP_ROUTING_MODE_UNSPECIFIED Unknown.
REGIONAL Regional mode.
GLOBAL Global mode.

Details

The created connection details.

Fields
state

State

The state of this connection.
error

string

The error message. This is only populated when state=ERROR.
cloud_router

CloudRouter

The Cloud Router info.
cloud_vpns[]

CloudVpn

Each connection has multiple Cloud VPN gateways.

CloudRouter

The Cloud Router info.

Fields
name

string

The associated Cloud Router name.

CloudVpn

The Cloud VPN info.

Fields
gateway

string

The created Cloud VPN gateway name.

State

The current connection state.

Enums
STATE_UNSPECIFIED Unknown.
STATE_CONNECTED Connected.
STATE_CONNECTING Still connecting.
STATE_ERROR Error occurred.

VpcProject

Project detail of the VPC network.

Fields
project_id

string

The project of the VPC to connect to. If not specified, it is the same as the cluster project.
service_account
(deprecated)

string

Optional. Deprecated: do not use.

ZonalProject

Zonal project (corresponding to the cloud consumer project) which get enabled on Zone(s).

Fields
name

string

Identifier. The resource name of the project.
create_time

Timestamp

Output only. The time when the project was created.
update_time

Timestamp

Output only. The time when the project was last updated.
labels

map<string, string>

Optional. Labels associated with this resource.
state

State

Output only. The state of the project on the zone.

State

The state of the project on the zone.

Enums
STATE_UNSPECIFIED Unspecified.
STATE_ON The project is enabled on the zone.
STATE_OFF The project is disabled on the zone.

ZonalService

Service enabled on the project.

Fields
name

string

Identifier. The resource name of the service.
service_selector

ServiceSelector

Required. The service to enable/disable.
state

State

Output only. The state of the service.
create_time

Timestamp

Output only. The time when the service was enabled.
update_time

Timestamp

Output only. The time when the service was last updated.
labels

map<string, string>

Optional. Labels associated with this resource.
Union field zone_or_cluster. The zone or cluster on which the service has to be enabled/disabled. zone_or_cluster can be only one of the following:
zone

string

The zone on which the service has to be enabled/disabled.
cluster

string

The fully qualified name of the cluster on which the service has to be enabled/disabled.

ServiceSelector

Services that can be enabled/disabled.

Enums
SERVICE_SELECTOR_UNSPECIFIED Unspecified.
ALLOYDB AlloyDB service, alloydb.googleapis.com.
VMM VMM service, gdcvmmanager.googleapis.com.

State

The state of the service.

Enums
STATE_UNSPECIFIED Unspecified.
STATE_ENABLED The service is enabled on the project.
STATE_DISABLED The service is disabled on the project.
STATE_ENABLING The service is being enabled on the project.
STATE_DISABLING The service is being disabled on the project.

Zone

Represents a zone.

Fields
name

string

Identifier. The canonical resource name of the zone. E.g. organizations/{organization}/locations/{location}/zones/{zone}
create_time

Timestamp

Output only. The time when the zone was created.
labels

map<string, string>

Optional. Labels associated with this resource.

ZoneMetadata

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

Fields
quota[]

Quota

Quota for resources in this zone.
rack_types

map<string, RackType>

The map keyed by rack name and has value of RackType.
config_data

ConfigData

Config data for the zone.

RackType

Type of the rack.

Enums
RACK_TYPE_UNSPECIFIED Unspecified rack type, single rack also belongs to this type.
BASE Base rack type, a pair of two modified Config-1 racks containing Aggregation switches.
EXPANSION Expansion rack type, also known as standalone racks, added by customers on demand.