Interface ClusterOrBuilder (0.61.0)

publicinterface ClusterOrBuilderextendsMessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

publicabstractbooleancontainsLabels(Stringkey)

Labels associated with this resource.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAuthorization()

publicabstractAuthorizationgetAuthorization()

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

.google.cloud.edgecontainer.v1.Authorization authorization = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Authorization

The authorization.

getAuthorizationOrBuilder()

publicabstractAuthorizationOrBuildergetAuthorizationOrBuilder()

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

.google.cloud.edgecontainer.v1.Authorization authorization = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
AuthorizationOrBuilder

getClusterCaCertificate()

publicabstractStringgetClusterCaCertificate()

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

string cluster_ca_certificate = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The clusterCaCertificate.

getClusterCaCertificateBytes()

publicabstractByteStringgetClusterCaCertificateBytes()

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

string cluster_ca_certificate = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for clusterCaCertificate.

getConnectionState()

publicabstractCluster.ConnectionStategetConnectionState()

Output only. The current connection state of the cluster.

.google.cloud.edgecontainer.v1.Cluster.ConnectionState connection_state = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.ConnectionState

The connectionState.

getConnectionStateOrBuilder()

publicabstractCluster.ConnectionStateOrBuildergetConnectionStateOrBuilder()

Output only. The current connection state of the cluster.

.google.cloud.edgecontainer.v1.Cluster.ConnectionState connection_state = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.ConnectionStateOrBuilder

getControlPlane()

publicabstractCluster.ControlPlanegetControlPlane()

Optional. The configuration of the cluster control plane.

.google.cloud.edgecontainer.v1.Cluster.ControlPlane control_plane = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.ControlPlane

The controlPlane.

getControlPlaneEncryption()

publicabstractCluster.ControlPlaneEncryptiongetControlPlaneEncryption()

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

.google.cloud.edgecontainer.v1.Cluster.ControlPlaneEncryption control_plane_encryption = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.ControlPlaneEncryption

The controlPlaneEncryption.

getControlPlaneEncryptionOrBuilder()

publicabstractCluster.ControlPlaneEncryptionOrBuildergetControlPlaneEncryptionOrBuilder()

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

.google.cloud.edgecontainer.v1.Cluster.ControlPlaneEncryption control_plane_encryption = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.ControlPlaneEncryptionOrBuilder

getControlPlaneOrBuilder()

publicabstractCluster.ControlPlaneOrBuildergetControlPlaneOrBuilder()

Optional. The configuration of the cluster control plane.

.google.cloud.edgecontainer.v1.Cluster.ControlPlane control_plane = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.ControlPlaneOrBuilder

getControlPlaneVersion()

publicabstractStringgetControlPlaneVersion()

Output only. The control plane release version

string control_plane_version = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The controlPlaneVersion.

getControlPlaneVersionBytes()

publicabstractByteStringgetControlPlaneVersionBytes()

Output only. The control plane release version

string control_plane_version = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for controlPlaneVersion.

getCreateTime()

publicabstractTimestampgetCreateTime()

Output only. The time when the cluster was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

publicabstractTimestampOrBuildergetCreateTimeOrBuilder()

Output only. The time when the cluster was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultMaxPodsPerNode()

publicabstractintgetDefaultMaxPodsPerNode()

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.

int32 default_max_pods_per_node = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The defaultMaxPodsPerNode.

getEndpoint()

publicabstractStringgetEndpoint()

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

string endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The endpoint.

getEndpointBytes()

publicabstractByteStringgetEndpointBytes()

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

string endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for endpoint.

getExternalLoadBalancerIpv4AddressPools(int index)

publicabstractStringgetExternalLoadBalancerIpv4AddressPools(intindex)

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

repeated string external_load_balancer_ipv4_address_pools = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The externalLoadBalancerIpv4AddressPools at the given index.

getExternalLoadBalancerIpv4AddressPoolsBytes(int index)

publicabstractByteStringgetExternalLoadBalancerIpv4AddressPoolsBytes(intindex)

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

repeated string external_load_balancer_ipv4_address_pools = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the externalLoadBalancerIpv4AddressPools at the given index.

getExternalLoadBalancerIpv4AddressPoolsCount()

publicabstractintgetExternalLoadBalancerIpv4AddressPoolsCount()

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

repeated string external_load_balancer_ipv4_address_pools = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of externalLoadBalancerIpv4AddressPools.

getExternalLoadBalancerIpv4AddressPoolsList()

publicabstractList<String>getExternalLoadBalancerIpv4AddressPoolsList()

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

repeated string external_load_balancer_ipv4_address_pools = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the externalLoadBalancerIpv4AddressPools.

getExternalLoadBalancerIpv6AddressPools(int index)

publicabstractStringgetExternalLoadBalancerIpv6AddressPools(intindex)

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

repeated string external_load_balancer_ipv6_address_pools = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The externalLoadBalancerIpv6AddressPools at the given index.

getExternalLoadBalancerIpv6AddressPoolsBytes(int index)

publicabstractByteStringgetExternalLoadBalancerIpv6AddressPoolsBytes(intindex)

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

repeated string external_load_balancer_ipv6_address_pools = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the externalLoadBalancerIpv6AddressPools at the given index.

getExternalLoadBalancerIpv6AddressPoolsCount()

publicabstractintgetExternalLoadBalancerIpv6AddressPoolsCount()

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

repeated string external_load_balancer_ipv6_address_pools = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of externalLoadBalancerIpv6AddressPools.

getExternalLoadBalancerIpv6AddressPoolsList()

publicabstractList<String>getExternalLoadBalancerIpv6AddressPoolsList()

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

repeated string external_load_balancer_ipv6_address_pools = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the externalLoadBalancerIpv6AddressPools.

getFleet()

publicabstractFleetgetFleet()

Required. Fleet configuration.

.google.cloud.edgecontainer.v1.Fleet fleet = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Fleet

The fleet.

getFleetOrBuilder()

publicabstractFleetOrBuildergetFleetOrBuilder()

Required. Fleet configuration.

.google.cloud.edgecontainer.v1.Fleet fleet = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FleetOrBuilder

getLabels() (deprecated)

publicabstractMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

publicabstractintgetLabelsCount()

Labels associated with this resource.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

publicabstractMap<String,String>getLabelsMap()

Labels associated with this resource.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

Labels associated with this resource.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

publicabstractStringgetLabelsOrThrow(Stringkey)

Labels associated with this resource.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getMaintenanceEvents(int index)

publicabstractCluster.MaintenanceEventgetMaintenanceEvents(intindex)

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

repeated .google.cloud.edgecontainer.v1.Cluster.MaintenanceEvent maintenance_events = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Cluster.MaintenanceEvent

getMaintenanceEventsCount()

publicabstractintgetMaintenanceEventsCount()

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

repeated .google.cloud.edgecontainer.v1.Cluster.MaintenanceEvent maintenance_events = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getMaintenanceEventsList()

publicabstractList<Cluster.MaintenanceEvent>getMaintenanceEventsList()

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

repeated .google.cloud.edgecontainer.v1.Cluster.MaintenanceEvent maintenance_events = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<MaintenanceEvent>

getMaintenanceEventsOrBuilder(int index)

publicabstractCluster.MaintenanceEventOrBuildergetMaintenanceEventsOrBuilder(intindex)

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

repeated .google.cloud.edgecontainer.v1.Cluster.MaintenanceEvent maintenance_events = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Cluster.MaintenanceEventOrBuilder

getMaintenanceEventsOrBuilderList()

publicabstractList<?extendsCluster.MaintenanceEventOrBuilder>getMaintenanceEventsOrBuilderList()

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

repeated .google.cloud.edgecontainer.v1.Cluster.MaintenanceEvent maintenance_events = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.edgecontainer.v1.Cluster.MaintenanceEventOrBuilder>

getMaintenancePolicy()

publicabstractMaintenancePolicygetMaintenancePolicy()

Optional. Cluster-wide maintenance policy configuration.

.google.cloud.edgecontainer.v1.MaintenancePolicy maintenance_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MaintenancePolicy

The maintenancePolicy.

getMaintenancePolicyOrBuilder()

publicabstractMaintenancePolicyOrBuildergetMaintenancePolicyOrBuilder()

Optional. Cluster-wide maintenance policy configuration.

.google.cloud.edgecontainer.v1.MaintenancePolicy maintenance_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MaintenancePolicyOrBuilder

getName()

publicabstractStringgetName()

Required. The resource name of the cluster.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

publicabstractByteStringgetNameBytes()

Required. The resource name of the cluster.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getNetworking()

publicabstractClusterNetworkinggetNetworking()

Required. Cluster-wide networking configuration.

.google.cloud.edgecontainer.v1.ClusterNetworking networking = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ClusterNetworking

The networking.

getNetworkingOrBuilder()

publicabstractClusterNetworkingOrBuildergetNetworkingOrBuilder()

Required. Cluster-wide networking configuration.

.google.cloud.edgecontainer.v1.ClusterNetworking networking = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ClusterNetworkingOrBuilder

getNodeVersion()

publicabstractStringgetNodeVersion()

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

string node_version = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The nodeVersion.

getNodeVersionBytes()

publicabstractByteStringgetNodeVersionBytes()

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

string node_version = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for nodeVersion.

getPort()

publicabstractintgetPort()

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

int32 port = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The port.

getReleaseChannel()

publicabstractCluster.ReleaseChannelgetReleaseChannel()

Optional. The release channel a cluster is subscribed to.

.google.cloud.edgecontainer.v1.Cluster.ReleaseChannel release_channel = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.ReleaseChannel

The releaseChannel.

getReleaseChannelValue()

publicabstractintgetReleaseChannelValue()

Optional. The release channel a cluster is subscribed to.

.google.cloud.edgecontainer.v1.Cluster.ReleaseChannel release_channel = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for releaseChannel.

getStatus()

publicabstractCluster.StatusgetStatus()

Output only. The current status of the cluster.

.google.cloud.edgecontainer.v1.Cluster.Status status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Status

The status.

getStatusValue()

publicabstractintgetStatusValue()

Output only. The current status of the cluster.

.google.cloud.edgecontainer.v1.Cluster.Status status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getSurvivabilityConfig()

publicabstractCluster.SurvivabilityConfiggetSurvivabilityConfig()

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.

.google.cloud.edgecontainer.v1.Cluster.SurvivabilityConfig survivability_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.SurvivabilityConfig

The survivabilityConfig.

getSurvivabilityConfigOrBuilder()

publicabstractCluster.SurvivabilityConfigOrBuildergetSurvivabilityConfigOrBuilder()

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.

.google.cloud.edgecontainer.v1.Cluster.SurvivabilityConfig survivability_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.SurvivabilityConfigOrBuilder

getSystemAddonsConfig()

publicabstractCluster.SystemAddonsConfiggetSystemAddonsConfig()

Optional. The configuration of the system add-ons.

.google.cloud.edgecontainer.v1.Cluster.SystemAddonsConfig system_addons_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.SystemAddonsConfig

The systemAddonsConfig.

getSystemAddonsConfigOrBuilder()

publicabstractCluster.SystemAddonsConfigOrBuildergetSystemAddonsConfigOrBuilder()

Optional. The configuration of the system add-ons.

.google.cloud.edgecontainer.v1.Cluster.SystemAddonsConfig system_addons_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.SystemAddonsConfigOrBuilder

getTargetVersion()

publicabstractStringgetTargetVersion()

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

string target_version = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The targetVersion.

getTargetVersionBytes()

publicabstractByteStringgetTargetVersionBytes()

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

string target_version = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for targetVersion.

getUpdateTime()

publicabstractTimestampgetUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAuthorization()

publicabstractbooleanhasAuthorization()

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

.google.cloud.edgecontainer.v1.Authorization authorization = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the authorization field is set.

hasConnectionState()

publicabstractbooleanhasConnectionState()

Output only. The current connection state of the cluster.

.google.cloud.edgecontainer.v1.Cluster.ConnectionState connection_state = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the connectionState field is set.

hasControlPlane()

publicabstractbooleanhasControlPlane()

Optional. The configuration of the cluster control plane.

.google.cloud.edgecontainer.v1.Cluster.ControlPlane control_plane = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the controlPlane field is set.

hasControlPlaneEncryption()

publicabstractbooleanhasControlPlaneEncryption()

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

.google.cloud.edgecontainer.v1.Cluster.ControlPlaneEncryption control_plane_encryption = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the controlPlaneEncryption field is set.

hasCreateTime()

publicabstractbooleanhasCreateTime()

Output only. The time when the cluster was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasFleet()

publicabstractbooleanhasFleet()

Required. Fleet configuration.

.google.cloud.edgecontainer.v1.Fleet fleet = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the fleet field is set.

hasMaintenancePolicy()

publicabstractbooleanhasMaintenancePolicy()

Optional. Cluster-wide maintenance policy configuration.

.google.cloud.edgecontainer.v1.MaintenancePolicy maintenance_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maintenancePolicy field is set.

hasNetworking()

publicabstractbooleanhasNetworking()

Required. Cluster-wide networking configuration.

.google.cloud.edgecontainer.v1.ClusterNetworking networking = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the networking field is set.

hasSurvivabilityConfig()

publicabstractbooleanhasSurvivabilityConfig()

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.

.google.cloud.edgecontainer.v1.Cluster.SurvivabilityConfig survivability_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the survivabilityConfig field is set.

hasSystemAddonsConfig()

publicabstractbooleanhasSystemAddonsConfig()

Optional. The configuration of the system add-ons.

.google.cloud.edgecontainer.v1.Cluster.SystemAddonsConfig system_addons_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the systemAddonsConfig field is set.

hasUpdateTime()

publicabstractbooleanhasUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.