public final class AwsCluster extends GeneratedMessageV3 implements AwsClusterOrBuilder
An Anthos cluster running on AWS.
Protobuf type google.cloud.gkemulticloud.v1.AwsCluster
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
AUTHORIZATION_FIELD_NUMBER
public static final int AUTHORIZATION_FIELD_NUMBER
Field Value
AWS_REGION_FIELD_NUMBER
public static final int AWS_REGION_FIELD_NUMBER
Field Value
CLUSTER_CA_CERTIFICATE_FIELD_NUMBER
public static final int CLUSTER_CA_CERTIFICATE_FIELD_NUMBER
Field Value
CONTROL_PLANE_FIELD_NUMBER
public static final int CONTROL_PLANE_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ENDPOINT_FIELD_NUMBER
public static final int ENDPOINT_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
FLEET_FIELD_NUMBER
public static final int FLEET_FIELD_NUMBER
Field Value
LOGGING_CONFIG_FIELD_NUMBER
public static final int LOGGING_CONFIG_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NETWORKING_FIELD_NUMBER
public static final int NETWORKING_FIELD_NUMBER
Field Value
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
WORKLOAD_IDENTITY_CONFIG_FIELD_NUMBER
public static final int WORKLOAD_IDENTITY_CONFIG_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AwsCluster getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AwsCluster.Builder newBuilder()
Returns
newBuilder(AwsCluster prototype)
public static AwsCluster.Builder newBuilder(AwsCluster prototype)
Parameter
Returns
public static AwsCluster parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AwsCluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AwsCluster parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AwsCluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AwsCluster parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AwsCluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AwsCluster parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AwsCluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AwsCluster parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AwsCluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AwsCluster parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AwsCluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AwsCluster> parser()
Returns
Methods
containsAnnotations(String key)
public 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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public 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];
getAnnotationsMap()
public 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];
getAnnotationsOrDefault(String key, String defaultValue)
public 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];
getAnnotationsOrThrow(String key)
public 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];
getAuthorization()
public AwsAuthorization getAuthorization()
Required. Configuration related to the cluster RBAC settings.
.google.cloud.gkemulticloud.v1.AwsAuthorization authorization = 15 [(.google.api.field_behavior) = REQUIRED];
getAuthorizationOrBuilder()
public AwsAuthorizationOrBuilder getAuthorizationOrBuilder()
Required. Configuration related to the cluster RBAC settings.
.google.cloud.gkemulticloud.v1.AwsAuthorization authorization = 15 [(.google.api.field_behavior) = REQUIRED];
getAwsRegion()
public 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];
| Type | Description |
| String | The awsRegion.
|
getAwsRegionBytes()
public 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];
getClusterCaCertificate()
public 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];
| Type | Description |
| String | The clusterCaCertificate.
|
getClusterCaCertificateBytes()
public 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];
| Type | Description |
| ByteString | The bytes for clusterCaCertificate.
|
getControlPlane()
public AwsControlPlane getControlPlane()
Required. Configuration related to the cluster control plane.
.google.cloud.gkemulticloud.v1.AwsControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];
getControlPlaneOrBuilder()
public AwsControlPlaneOrBuilder getControlPlaneOrBuilder()
Required. Configuration related to the cluster control plane.
.google.cloud.gkemulticloud.v1.AwsControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which this cluster was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which this cluster was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public AwsCluster getDefaultInstanceForType()
Returns
getDescription()
public 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];
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public 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];
| Type | Description |
| ByteString | The bytes for description.
|
getEndpoint()
public String getEndpoint()
Output only. The endpoint of the cluster's API server.
string endpoint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The endpoint.
|
getEndpointBytes()
public ByteString getEndpointBytes()
Output only. The endpoint of the cluster's API server.
string endpoint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
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;
| Type | Description |
| String | The etag.
|
getEtagBytes()
public 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;
getFleet()
Optional. Fleet configuration.
.google.cloud.gkemulticloud.v1.Fleet fleet = 18 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Fleet | The fleet.
|
getFleetOrBuilder()
public FleetOrBuilder getFleetOrBuilder()
Optional. Fleet configuration.
.google.cloud.gkemulticloud.v1.Fleet fleet = 18 [(.google.api.field_behavior) = OPTIONAL];
getLoggingConfig()
public LoggingConfig getLoggingConfig()
Optional. Logging configuration for this cluster.
.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 19 [(.google.api.field_behavior) = OPTIONAL];
getLoggingConfigOrBuilder()
public LoggingConfigOrBuilder getLoggingConfigOrBuilder()
Optional. Logging configuration for this cluster.
.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 19 [(.google.api.field_behavior) = OPTIONAL];
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 GCP resource names.
string name = 1;
| Type | Description |
| String | The name.
|
getNameBytes()
public 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 GCP resource names.
string name = 1;
getNetworking()
public AwsClusterNetworking getNetworking()
Required. Cluster-wide networking configuration.
.google.cloud.gkemulticloud.v1.AwsClusterNetworking networking = 3 [(.google.api.field_behavior) = REQUIRED];
getNetworkingOrBuilder()
public AwsClusterNetworkingOrBuilder getNetworkingOrBuilder()
Required. Cluster-wide networking configuration.
.google.cloud.gkemulticloud.v1.AwsClusterNetworking networking = 3 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<AwsCluster> getParserForType()
Returns
Overrides
getReconciling()
public boolean getReconciling()
Output only. If set, there are currently changes in flight to the cluster.
bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | The reconciling.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public 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];
getStateValue()
public int getStateValue()
Output only. The current state of the cluster.
.google.cloud.gkemulticloud.v1.AwsCluster.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUid()
Output only. A globally unique identifier for the cluster.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUidBytes()
public ByteString getUidBytes()
Output only. A globally unique identifier for the cluster.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public 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];
getUpdateTimeOrBuilder()
public 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];
getWorkloadIdentityConfig()
public WorkloadIdentityConfig getWorkloadIdentityConfig()
Output only. Workload Identity settings.
.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
getWorkloadIdentityConfigOrBuilder()
public WorkloadIdentityConfigOrBuilder getWorkloadIdentityConfigOrBuilder()
Output only. Workload Identity settings.
.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasAuthorization()
public boolean hasAuthorization()
Required. Configuration related to the cluster RBAC settings.
.google.cloud.gkemulticloud.v1.AwsAuthorization authorization = 15 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the authorization field is set.
|
hasControlPlane()
public boolean hasControlPlane()
Required. Configuration related to the cluster control plane.
.google.cloud.gkemulticloud.v1.AwsControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the controlPlane field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which this cluster was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasFleet()
public boolean hasFleet()
Optional. Fleet configuration.
.google.cloud.gkemulticloud.v1.Fleet fleet = 18 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the fleet field is set.
|
hasLoggingConfig()
public boolean hasLoggingConfig()
Optional. Logging configuration for this cluster.
.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 19 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the loggingConfig field is set.
|
hasNetworking()
public boolean hasNetworking()
Required. Cluster-wide networking configuration.
.google.cloud.gkemulticloud.v1.AwsClusterNetworking networking = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the networking field is set.
|
hasUpdateTime()
public 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hasWorkloadIdentityConfig()
public boolean hasWorkloadIdentityConfig()
Output only. Workload Identity settings.
.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the workloadIdentityConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AwsCluster.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AwsCluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AwsCluster.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
