Interface AwsClusterOrBuilder (0.46.0)

Version 0.46.0

• 0.53.0 (latest)
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.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.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 AwsClusterOrBuilder 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 = 14 [(.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 = 14 [(.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 = 14 [(.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 = 14 [(.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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getAuthorization()

public abstract AwsAuthorization getAuthorization()

Required. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AwsAuthorization authorization = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsAuthorization	The authorization.

getAuthorizationOrBuilder()

public abstract AwsAuthorizationOrBuilder getAuthorizationOrBuilder()

Required. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AwsAuthorization authorization = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsAuthorizationOrBuilder

getAwsRegion()

public abstract String getAwsRegion()

Required. The AWS region where the cluster runs.

Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

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

Returns
Type	Description
String	The awsRegion.

getAwsRegionBytes()

public abstract ByteString getAwsRegionBytes()

Required. The AWS region where the cluster runs.

Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

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

Returns
Type	Description
ByteString	The bytes for awsRegion.

getBinaryAuthorization()

public abstract BinaryAuthorization getBinaryAuthorization()

Optional. Binary Authorization configuration for this cluster.

.google.cloud.gkemulticloud.v1.BinaryAuthorization binary_authorization = 22 [(.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 = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BinaryAuthorizationOrBuilder

getClusterCaCertificate()

public abstract String getClusterCaCertificate()

Output only. PEM encoded x509 certificate of the cluster root of trust.

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

Returns
Type	Description
String	The clusterCaCertificate.

getClusterCaCertificateBytes()

public abstract ByteString getClusterCaCertificateBytes()

Output only. PEM encoded x509 certificate of the cluster root of trust.

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

Returns
Type	Description
ByteString	The bytes for clusterCaCertificate.

getControlPlane()

public abstract AwsControlPlane getControlPlane()

Required. Configuration related to the cluster control plane.

.google.cloud.gkemulticloud.v1.AwsControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsControlPlane	The controlPlane.

getControlPlaneOrBuilder()

public abstract AwsControlPlaneOrBuilder getControlPlaneOrBuilder()

Required. Configuration related to the cluster control plane.

.google.cloud.gkemulticloud.v1.AwsControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsControlPlaneOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 11 [(.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 created.

.google.protobuf.Timestamp create_time = 11 [(.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.

getEndpoint()

public abstract String getEndpoint()

Output only. The endpoint of the cluster's API server.

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

Returns
Type	Description
String	The endpoint.

getEndpointBytes()

public abstract ByteString getEndpointBytes()

Output only. The endpoint of the cluster's API server.

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

Returns
Type	Description
ByteString	The bytes for endpoint.

getErrors(int index)

public abstract AwsClusterError getErrors(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
AwsClusterError

getErrorsCount()

public abstract int getErrorsCount()

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

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

Returns
Type	Description
int

getErrorsList()

public abstract List<AwsClusterError> getErrorsList()

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

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

Returns
Type	Description
List<AwsClusterError>

getErrorsOrBuilder(int index)

public abstract AwsClusterErrorOrBuilder getErrorsOrBuilder(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
AwsClusterErrorOrBuilder

getErrorsOrBuilderList()

public abstract List<? extends AwsClusterErrorOrBuilder> getErrorsOrBuilderList()

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

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

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

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 = 13;

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 = 13;

Returns
Type	Description
ByteString	The bytes for etag.

getFleet()

public abstract Fleet getFleet()

Required. Fleet configuration.

.google.cloud.gkemulticloud.v1.Fleet fleet = 18 [(.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 = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FleetOrBuilder

getLoggingConfig()

public abstract LoggingConfig getLoggingConfig()

Optional. Logging configuration for this cluster.

.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 19 [(.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 = 19 [(.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 = 21 [(.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 = 21 [(.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>/awsClusters/<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>/awsClusters/<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.

getNetworking()

public abstract AwsClusterNetworking getNetworking()

Required. Cluster-wide networking configuration.

.google.cloud.gkemulticloud.v1.AwsClusterNetworking networking = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsClusterNetworking	The networking.

getNetworkingOrBuilder()

public abstract AwsClusterNetworkingOrBuilder getNetworkingOrBuilder()

Required. Cluster-wide networking configuration.

.google.cloud.gkemulticloud.v1.AwsClusterNetworking networking = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsClusterNetworkingOrBuilder

getReconciling()

public abstract boolean getReconciling()

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

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

Returns
Type	Description
boolean	The reconciling.

getState()

public abstract AwsCluster.State getState()

Output only. The current state of the cluster.

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

Returns
Type	Description
AwsCluster.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state of the cluster.

.google.cloud.gkemulticloud.v1.AwsCluster.State state = 7 [(.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 = 9 [(.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 = 9 [(.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 = 12 [(.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 = 12 [(.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 = 16 [(.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 = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
WorkloadIdentityConfigOrBuilder

hasAuthorization()

public abstract boolean hasAuthorization()

Required. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AwsAuthorization authorization = 15 [(.google.api.field_behavior) = REQUIRED];

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 = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the binaryAuthorization field is set.

hasControlPlane()

public abstract boolean hasControlPlane()

Required. Configuration related to the cluster control plane.

.google.cloud.gkemulticloud.v1.AwsControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the controlPlane field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 11 [(.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 = 18 [(.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 = 19 [(.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 = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the monitoringConfig field is set.

hasNetworking()

public abstract boolean hasNetworking()

Required. Cluster-wide networking configuration.

.google.cloud.gkemulticloud.v1.AwsClusterNetworking networking = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the networking field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 12 [(.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 = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the workloadIdentityConfig field is set.