Package com.google.cloud.gkemulticloud.v1

Class AttachedCluster

  • All Implemented Interfaces:
    AttachedClusterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AttachedCluster
extends com.google.protobuf.GeneratedMessageV3
implements AttachedClusterOrBuilder
     An Anthos cluster running on customer own infrastructure.
    Protobuf type google.cloud.gkemulticloud.v1.AttachedCluster
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         The name of this resource.

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

 See [Resource Names](https://cloud.google.com/apis/design/resource_names)
 for more details on Google Cloud Platform resource names.
        string name = 1;
        Specified by:
        getName in interface AttachedClusterOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of this resource.

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

 See [Resource Names](https://cloud.google.com/apis/design/resource_names)
 for more details on Google Cloud Platform resource names.
        string name = 1;
        Specified by:
        getNameBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getDescription in interface AttachedClusterOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.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];
        Specified by:
        getDescriptionBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for description.

      • hasOidcConfig

        public boolean hasOidcConfig()
         Required. OpenID Connect (OIDC) configuration for the cluster.
        .google.cloud.gkemulticloud.v1.AttachedOidcConfig oidc_config = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasOidcConfig in interface AttachedClusterOrBuilder
        Returns:
        Whether the oidcConfig field is set.

      • getOidcConfig

        public AttachedOidcConfig getOidcConfig()
         Required. OpenID Connect (OIDC) configuration for the cluster.
        .google.cloud.gkemulticloud.v1.AttachedOidcConfig oidc_config = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOidcConfig in interface AttachedClusterOrBuilder
        Returns:
        The oidcConfig.

      • getPlatformVersion

        public 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][google.cloud.gkemulticloud.v1.AttachedClusters.GetAttachedServerConfig].
        string platform_version = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlatformVersion in interface AttachedClusterOrBuilder
        Returns:
        The platformVersion.

      • getPlatformVersionBytes

        public com.google.protobuf.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][google.cloud.gkemulticloud.v1.AttachedClusters.GetAttachedServerConfig].
        string platform_version = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlatformVersionBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for platformVersion.

      • getDistribution

        public String getDistribution()
         Required. The Kubernetes distribution of the underlying attached cluster.

 Supported values: ["eks", "aks"].
        string distribution = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDistribution in interface AttachedClusterOrBuilder
        Returns:
        The distribution.

      • getDistributionBytes

        public com.google.protobuf.ByteString getDistributionBytes()
         Required. The Kubernetes distribution of the underlying attached cluster.

 Supported values: ["eks", "aks"].
        string distribution = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDistributionBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for distribution.

      • getClusterRegion

        public 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];
        Specified by:
        getClusterRegion in interface AttachedClusterOrBuilder
        Returns:
        The clusterRegion.

      • getClusterRegionBytes

        public com.google.protobuf.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];
        Specified by:
        getClusterRegionBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for clusterRegion.

      • hasFleet

        public boolean hasFleet()
         Required. Fleet configuration.
        .google.cloud.gkemulticloud.v1.Fleet fleet = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasFleet in interface AttachedClusterOrBuilder
        Returns:
        Whether the fleet field is set.

      • getFleet

        public Fleet getFleet()
         Required. Fleet configuration.
        .google.cloud.gkemulticloud.v1.Fleet fleet = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFleet in interface AttachedClusterOrBuilder
        Returns:
        The fleet.

      • getStateValue

        public int getStateValue()
         Output only. The current state of the cluster.
        .google.cloud.gkemulticloud.v1.AttachedCluster.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface AttachedClusterOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public 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];
        Specified by:
        getState in interface AttachedClusterOrBuilder
        Returns:
        The state.

      • getUid

        public String getUid()
         Output only. A globally unique identifier for the cluster.
        string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface AttachedClusterOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. A globally unique identifier for the cluster.
        string uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for uid.

      • getReconciling

        public boolean getReconciling()
         Output only. If set, there are currently changes in flight to the cluster.
        bool reconciling = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getReconciling in interface AttachedClusterOrBuilder
        Returns:
        The reconciling.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time at which this cluster was registered.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface AttachedClusterOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time at which this cluster was registered.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface AttachedClusterOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which this cluster was registered.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface AttachedClusterOrBuilder

      • hasUpdateTime

        public 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];
        Specified by:
        hasUpdateTime in interface AttachedClusterOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.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];
        Specified by:
        getUpdateTime in interface AttachedClusterOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getUpdateTimeOrBuilder in interface AttachedClusterOrBuilder

      • getEtag

        public 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;
        Specified by:
        getEtag in interface AttachedClusterOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.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;
        Specified by:
        getEtagBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for etag.

      • getKubernetesVersion

        public String getKubernetesVersion()
         Output only. The Kubernetes version of the cluster.
        string kubernetes_version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getKubernetesVersion in interface AttachedClusterOrBuilder
        Returns:
        The kubernetesVersion.

      • getKubernetesVersionBytes

        public com.google.protobuf.ByteString getKubernetesVersionBytes()
         Output only. The Kubernetes version of the cluster.
        string kubernetes_version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getKubernetesVersionBytes in interface AttachedClusterOrBuilder
        Returns:
        The bytes for kubernetesVersion.

      • getAnnotationsCount

        public int getAnnotationsCount()
        Description copied from interface: AttachedClusterOrBuilder
         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];
        Specified by:
        getAnnotationsCount in interface AttachedClusterOrBuilder

      • containsAnnotations

        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 = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsAnnotations in interface AttachedClusterOrBuilder

      • 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 = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsMap in interface AttachedClusterOrBuilder

      • getAnnotationsOrDefault

        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 = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsOrDefault in interface AttachedClusterOrBuilder

      • getAnnotationsOrThrow

        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 = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsOrThrow in interface AttachedClusterOrBuilder

      • hasWorkloadIdentityConfig

        public boolean hasWorkloadIdentityConfig()
         Output only. Workload Identity settings.
        .google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasWorkloadIdentityConfig in interface AttachedClusterOrBuilder
        Returns:
        Whether the workloadIdentityConfig field is set.

      • getWorkloadIdentityConfig

        public WorkloadIdentityConfig getWorkloadIdentityConfig()
         Output only. Workload Identity settings.
        .google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getWorkloadIdentityConfig in interface AttachedClusterOrBuilder
        Returns:
        The workloadIdentityConfig.

      • hasLoggingConfig

        public boolean hasLoggingConfig()
         Optional. Logging configuration for this cluster.
        .google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasLoggingConfig in interface AttachedClusterOrBuilder
        Returns:
        Whether the loggingConfig field is set.

      • getLoggingConfig

        public LoggingConfig getLoggingConfig()
         Optional. Logging configuration for this cluster.
        .google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLoggingConfig in interface AttachedClusterOrBuilder
        Returns:
        The loggingConfig.

      • getErrorsList

        public 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];
        Specified by:
        getErrorsList in interface AttachedClusterOrBuilder

      • getErrorsCount

        public 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];
        Specified by:
        getErrorsCount in interface AttachedClusterOrBuilder

      • getErrors

        public 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];
        Specified by:
        getErrors in interface AttachedClusterOrBuilder

      • hasAuthorization

        public boolean hasAuthorization()
         Optional. Configuration related to the cluster RBAC settings.
        .google.cloud.gkemulticloud.v1.AttachedClustersAuthorization authorization = 21 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasAuthorization in interface AttachedClusterOrBuilder
        Returns:
        Whether the authorization field is set.

      • getAuthorization

        public AttachedClustersAuthorization getAuthorization()
         Optional. Configuration related to the cluster RBAC settings.
        .google.cloud.gkemulticloud.v1.AttachedClustersAuthorization authorization = 21 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorization in interface AttachedClusterOrBuilder
        Returns:
        The authorization.

      • hasMonitoringConfig

        public boolean hasMonitoringConfig()
         Optional. Monitoring configuration for this cluster.
        .google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 23 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasMonitoringConfig in interface AttachedClusterOrBuilder
        Returns:
        Whether the monitoringConfig field is set.

      • getMonitoringConfig

        public MonitoringConfig getMonitoringConfig()
         Optional. Monitoring configuration for this cluster.
        .google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 23 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMonitoringConfig in interface AttachedClusterOrBuilder
        Returns:
        The monitoringConfig.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AttachedCluster parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AttachedCluster parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AttachedCluster parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AttachedCluster parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AttachedCluster parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AttachedCluster parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AttachedCluster parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AttachedCluster.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AttachedCluster.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AttachedCluster.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<AttachedCluster> parser()

      • getParserForType

        public com.google.protobuf.Parser<AttachedCluster> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AttachedCluster getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder