Package com.google.cloud.gkemulticloud.v1

Interface AttachedClusterOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AttachedCluster, AttachedCluster.Builder
    public interface AttachedClusterOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • getDescription

        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:
        The description.

      • getDescriptionBytes

        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];
        Returns:
        The bytes for description.

      • hasOidcConfig

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

      • getOidcConfig

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

      • getOidcConfigOrBuilder

        AttachedOidcConfigOrBuilder getOidcConfigOrBuilder()
         Required. OpenID Connect (OIDC) configuration for the cluster.
        .google.cloud.gkemulticloud.v1.AttachedOidcConfig oidc_config = 3 [(.google.api.field_behavior) = REQUIRED];

      • getPlatformVersion

        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];
        Returns:
        The platformVersion.

      • getPlatformVersionBytes

        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];
        Returns:
        The bytes for platformVersion.

      • getDistribution

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

 Supported values: ["eks", "aks"].
        string distribution = 16 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The distribution.

      • getDistributionBytes

        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];
        Returns:
        The bytes for distribution.

      • getClusterRegion

        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:
        The clusterRegion.

      • getClusterRegionBytes

        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];
        Returns:
        The bytes for clusterRegion.

      • hasFleet

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

      • getFleet

        Fleet getFleet()
         Required. Fleet configuration.
        .google.cloud.gkemulticloud.v1.Fleet fleet = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The fleet.

      • getFleetOrBuilder

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

      • getStateValue

        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:
        The enum numeric value on the wire for state.

      • getState

        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:
        The state.

      • getUid

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

      • getUidBytes

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

      • getReconciling

        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:
        The reconciling.

      • hasCreateTime

        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:
        Whether the createTime field is set.

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        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];

      • getEtag

        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:
        The etag.

      • getEtagBytes

        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;
        Returns:
        The bytes for etag.

      • getKubernetesVersion

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

      • getKubernetesVersionBytes

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

      • getAnnotationsCount

        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];

      • containsAnnotations

        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];

      • getAnnotationsMap

        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];

      • getAnnotationsOrDefault

        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];

      • getAnnotationsOrThrow

        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];

      • hasWorkloadIdentityConfig

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

      • getWorkloadIdentityConfig

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

      • getWorkloadIdentityConfigOrBuilder

        WorkloadIdentityConfigOrBuilder getWorkloadIdentityConfigOrBuilder()
         Output only. Workload Identity settings.
        .google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasLoggingConfig

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

      • getLoggingConfig

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

      • getLoggingConfigOrBuilder

        LoggingConfigOrBuilder getLoggingConfigOrBuilder()
         Optional. Logging configuration for this cluster.
        .google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 15 [(.google.api.field_behavior) = OPTIONAL];

      • getErrorsList

        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];

      • getErrors

        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];

      • getErrorsCount

        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];

      • getErrorsOrBuilderList

        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];

      • getErrorsOrBuilder

        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];

      • hasAuthorization

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

      • getAuthorization

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

      • getAuthorizationOrBuilder

        AttachedClustersAuthorizationOrBuilder getAuthorizationOrBuilder()
         Optional. Configuration related to the cluster RBAC settings.
        .google.cloud.gkemulticloud.v1.AttachedClustersAuthorization authorization = 21 [(.google.api.field_behavior) = OPTIONAL];

      • hasMonitoringConfig

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

      • getMonitoringConfig

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

      • getMonitoringConfigOrBuilder

        MonitoringConfigOrBuilder getMonitoringConfigOrBuilder()
         Optional. Monitoring configuration for this cluster.
        .google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 23 [(.google.api.field_behavior) = OPTIONAL];