Interface ClusterOrBuilder (0.37.0)

Version 0.37.0

• 0.50.0 (latest)
• 0.49.0
• 0.48.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface ClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels associated with this resource.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAuthorization()

public abstract Authorization getAuthorization()

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

public abstract AuthorizationOrBuilder getAuthorizationOrBuilder()

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

public abstract String getClusterCaCertificate()

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

public abstract ByteString getClusterCaCertificateBytes()

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.

getControlPlane()

public abstract Cluster.ControlPlane getControlPlane()

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

public abstract Cluster.ControlPlaneEncryption getControlPlaneEncryption()

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

public abstract Cluster.ControlPlaneEncryptionOrBuilder getControlPlaneEncryptionOrBuilder()

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

public abstract Cluster.ControlPlaneOrBuilder getControlPlaneOrBuilder()

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

public abstract String getControlPlaneVersion()

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

public abstract ByteString getControlPlaneVersionBytes()

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

public abstract Timestamp getCreateTime()

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

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

public abstract int getDefaultMaxPodsPerNode()

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

public abstract String getEndpoint()

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

public abstract ByteString getEndpointBytes()

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)

public abstract String getExternalLoadBalancerIpv4AddressPools(int index)

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)

public abstract ByteString getExternalLoadBalancerIpv4AddressPoolsBytes(int index)

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

public abstract int getExternalLoadBalancerIpv4AddressPoolsCount()

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

public abstract List<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)

public abstract String getExternalLoadBalancerIpv6AddressPools(int index)

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)

public abstract ByteString getExternalLoadBalancerIpv6AddressPoolsBytes(int index)

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

public abstract int getExternalLoadBalancerIpv6AddressPoolsCount()

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

public abstract List<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()

public abstract Fleet getFleet()

Required. Fleet configuration.

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

Returns
Type	Description
Fleet	The fleet.

getFleetOrBuilder()

public abstract FleetOrBuilder getFleetOrBuilder()

Required. Fleet configuration.

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

Returns
Type	Description
FleetOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels associated with this resource.

map<string, string> labels = 4;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels associated with this resource.

map<string, string> labels = 4;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this resource.

map<string, string> labels = 4;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels associated with this resource.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMaintenanceEvents(int index)

public abstract Cluster.MaintenanceEvent getMaintenanceEvents(int index)

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

public abstract int getMaintenanceEventsCount()

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

public abstract List<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)

public abstract Cluster.MaintenanceEventOrBuilder getMaintenanceEventsOrBuilder(int index)

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

public abstract List<? extends Cluster.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()

public abstract MaintenancePolicy getMaintenancePolicy()

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

public abstract MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()

Optional. Cluster-wide maintenance policy configuration.

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

Returns
Type	Description
MaintenancePolicyOrBuilder

getName()

public abstract String getName()

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

public abstract ByteString getNameBytes()

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

public abstract ClusterNetworking getNetworking()

Required. Cluster-wide networking configuration.

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

Returns
Type	Description
ClusterNetworking	The networking.

getNetworkingOrBuilder()

public abstract ClusterNetworkingOrBuilder getNetworkingOrBuilder()

Required. Cluster-wide networking configuration.

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

Returns
Type	Description
ClusterNetworkingOrBuilder

getNodeVersion()

public abstract String getNodeVersion()

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

public abstract ByteString getNodeVersionBytes()

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

public abstract int getPort()

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

public abstract Cluster.ReleaseChannel getReleaseChannel()

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

public abstract int getReleaseChannelValue()

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

public abstract Cluster.Status getStatus()

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

public abstract int getStatusValue()

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

public abstract Cluster.SurvivabilityConfig getSurvivabilityConfig()

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

public abstract Cluster.SurvivabilityConfigOrBuilder getSurvivabilityConfigOrBuilder()

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

public abstract Cluster.SystemAddonsConfig getSystemAddonsConfig()

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

public abstract Cluster.SystemAddonsConfigOrBuilder getSystemAddonsConfigOrBuilder()

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

public abstract String getTargetVersion()

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

public abstract ByteString getTargetVersionBytes()

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

public abstract Timestamp getUpdateTime()

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

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

public abstract boolean hasAuthorization()

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.

hasControlPlane()

public abstract boolean hasControlPlane()

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

public abstract boolean hasControlPlaneEncryption()

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

public abstract boolean hasCreateTime()

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

public abstract boolean hasFleet()

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

public abstract boolean hasMaintenancePolicy()

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

public abstract boolean hasNetworking()

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

public abstract boolean hasSurvivabilityConfig()

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

public abstract boolean hasSystemAddonsConfig()

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

public abstract boolean hasUpdateTime()

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.