Interface AttachedClusterOrBuilder (0.40.0)

Version latest

• 0.40.0 (latest)
• 0.39.0
• 0.38.0
• 0.36.0
• 0.35.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.23.0
• 0.22.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.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.6
• 0.1.0

public interface AttachedClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

Optional. Annotations on the cluster.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

Optional. Annotations on the cluster.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

Optional. Annotations on the cluster.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

Optional. Annotations on the cluster.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

Optional. Annotations on the cluster.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getAuthorization()

public abstract AttachedClustersAuthorization getAuthorization()

Optional. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AttachedClustersAuthorization authorization = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AttachedClustersAuthorization	The authorization.

getAuthorizationOrBuilder()

public abstract AttachedClustersAuthorizationOrBuilder getAuthorizationOrBuilder()

Optional. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AttachedClustersAuthorization authorization = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AttachedClustersAuthorizationOrBuilder

getBinaryAuthorization()

public abstract BinaryAuthorization getBinaryAuthorization()

Optional. Binary Authorization configuration for this cluster.

.google.cloud.gkemulticloud.v1.BinaryAuthorization binary_authorization = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BinaryAuthorization	The binaryAuthorization.

getBinaryAuthorizationOrBuilder()

public abstract BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Optional. Binary Authorization configuration for this cluster.

.google.cloud.gkemulticloud.v1.BinaryAuthorization binary_authorization = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BinaryAuthorizationOrBuilder

getClusterRegion()

public abstract String getClusterRegion()

Output only. The region where this cluster runs.

For EKS clusters, this is a AWS region. For AKS clusters, this is an Azure region.

string cluster_region = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The clusterRegion.

getClusterRegionBytes()

public abstract ByteString getClusterRegionBytes()

Output only. The region where this cluster runs.

For EKS clusters, this is a AWS region. For AKS clusters, this is an Azure region.

string cluster_region = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for clusterRegion.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time at which this cluster was registered.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which this cluster was registered.

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

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDistribution()

public abstract String getDistribution()

Required. The Kubernetes distribution of the underlying attached cluster.

Supported values: ["eks", "aks", "generic"].

string distribution = 16 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The distribution.

getDistributionBytes()

public abstract ByteString getDistributionBytes()

Required. The Kubernetes distribution of the underlying attached cluster.

Supported values: ["eks", "aks", "generic"].

string distribution = 16 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for distribution.

getErrors(int index)

public abstract AttachedClusterError getErrors(int index)

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AttachedClusterError errors = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
AttachedClusterError

getErrorsCount()

public abstract int getErrorsCount()

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AttachedClusterError errors = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getErrorsList()

public abstract List<AttachedClusterError> getErrorsList()

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AttachedClusterError errors = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<AttachedClusterError>

getErrorsOrBuilder(int index)

public abstract AttachedClusterErrorOrBuilder getErrorsOrBuilder(int index)

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AttachedClusterError errors = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
AttachedClusterErrorOrBuilder

getErrorsOrBuilderList()

public abstract List<? extends AttachedClusterErrorOrBuilder> getErrorsOrBuilderList()

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AttachedClusterError errors = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.gkemulticloud.v1.AttachedClusterErrorOrBuilder>

getEtag()

public abstract String getEtag()

Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 11;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 11;

Returns
Type	Description
ByteString	The bytes for etag.

getFleet()

public abstract Fleet getFleet()

Required. Fleet configuration.

.google.cloud.gkemulticloud.v1.Fleet fleet = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Fleet	The fleet.

getFleetOrBuilder()

public abstract FleetOrBuilder getFleetOrBuilder()

Required. Fleet configuration.

.google.cloud.gkemulticloud.v1.Fleet fleet = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FleetOrBuilder

getKubernetesVersion()

public abstract String getKubernetesVersion()

Output only. The Kubernetes version of the cluster.

string kubernetes_version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The kubernetesVersion.

getKubernetesVersionBytes()

public abstract ByteString getKubernetesVersionBytes()

Output only. The Kubernetes version of the cluster.

string kubernetes_version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for kubernetesVersion.

getLoggingConfig()

public abstract LoggingConfig getLoggingConfig()

Optional. Logging configuration for this cluster.

.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LoggingConfig	The loggingConfig.

getLoggingConfigOrBuilder()

public abstract LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Optional. Logging configuration for this cluster.

.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LoggingConfigOrBuilder

getMonitoringConfig()

public abstract MonitoringConfig getMonitoringConfig()

Optional. Monitoring configuration for this cluster.

.google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MonitoringConfig	The monitoringConfig.

getMonitoringConfigOrBuilder()

public abstract MonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

Optional. Monitoring configuration for this cluster.

.google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MonitoringConfigOrBuilder

getName()

public abstract String getName()

The name of this resource.

Cluster names are formatted as projects/<project-number>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of this resource.

Cluster names are formatted as projects/<project-number>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getOidcConfig()

public abstract AttachedOidcConfig getOidcConfig()

Required. OpenID Connect (OIDC) configuration for the cluster.

.google.cloud.gkemulticloud.v1.AttachedOidcConfig oidc_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AttachedOidcConfig	The oidcConfig.

getOidcConfigOrBuilder()

public abstract AttachedOidcConfigOrBuilder getOidcConfigOrBuilder()

Required. OpenID Connect (OIDC) configuration for the cluster.

.google.cloud.gkemulticloud.v1.AttachedOidcConfig oidc_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AttachedOidcConfigOrBuilder

getPlatformVersion()

public abstract String getPlatformVersion()

Required. The platform version for the cluster (e.g. 1.19.0-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAttachedServerConfig.

string platform_version = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The platformVersion.

getPlatformVersionBytes()

public abstract ByteString getPlatformVersionBytes()

Required. The platform version for the cluster (e.g. 1.19.0-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAttachedServerConfig.

string platform_version = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for platformVersion.

getProxyConfig()

public abstract AttachedProxyConfig getProxyConfig()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AttachedProxyConfig proxy_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AttachedProxyConfig	The proxyConfig.

getProxyConfigOrBuilder()

public abstract AttachedProxyConfigOrBuilder getProxyConfigOrBuilder()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AttachedProxyConfig proxy_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AttachedProxyConfigOrBuilder

getReconciling()

public abstract boolean getReconciling()

Output only. If set, there are currently changes in flight to the cluster.

bool reconciling = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The reconciling.

getState()

public abstract AttachedCluster.State getState()

Output only. The current state of the cluster.

.google.cloud.gkemulticloud.v1.AttachedCluster.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AttachedCluster.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state of the cluster.

.google.cloud.gkemulticloud.v1.AttachedCluster.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUid()

public abstract String getUid()

Output only. A globally unique identifier for the cluster.

string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. A globally unique identifier for the cluster.

string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time at which this cluster was last updated.

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which this cluster was last updated.

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

Returns
Type	Description
TimestampOrBuilder

getWorkloadIdentityConfig()

public abstract WorkloadIdentityConfig getWorkloadIdentityConfig()

Output only. Workload Identity settings.

.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
WorkloadIdentityConfig	The workloadIdentityConfig.

getWorkloadIdentityConfigOrBuilder()

public abstract WorkloadIdentityConfigOrBuilder getWorkloadIdentityConfigOrBuilder()

Output only. Workload Identity settings.

.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
WorkloadIdentityConfigOrBuilder

hasAuthorization()

public abstract boolean hasAuthorization()

Optional. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AttachedClustersAuthorization authorization = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the authorization field is set.

hasBinaryAuthorization()

public abstract boolean hasBinaryAuthorization()

Optional. Binary Authorization configuration for this cluster.

.google.cloud.gkemulticloud.v1.BinaryAuthorization binary_authorization = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the binaryAuthorization field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time at which this cluster was registered.

.google.protobuf.Timestamp create_time = 9 [(.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.gkemulticloud.v1.Fleet fleet = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the fleet field is set.

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Optional. Logging configuration for this cluster.

.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the loggingConfig field is set.

hasMonitoringConfig()

public abstract boolean hasMonitoringConfig()

Optional. Monitoring configuration for this cluster.

.google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the monitoringConfig field is set.

hasOidcConfig()

public abstract boolean hasOidcConfig()

Required. OpenID Connect (OIDC) configuration for the cluster.

.google.cloud.gkemulticloud.v1.AttachedOidcConfig oidc_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the oidcConfig field is set.

hasProxyConfig()

public abstract boolean hasProxyConfig()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AttachedProxyConfig proxy_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the proxyConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time at which this cluster was last updated.

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

Returns
Type	Description
boolean	Whether the updateTime field is set.

hasWorkloadIdentityConfig()

public abstract boolean hasWorkloadIdentityConfig()

Output only. Workload Identity settings.

.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the workloadIdentityConfig field is set.