Anthos Multi-Cloud V1 API - Class Google::Cloud::GkeMultiCloud::V1::AttachedCluster (v0.4.0)

Version 0.4.0

• 0.10.0 (latest)
• 0.9.0
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Anthos Multi-Cloud V1 API class Google::Cloud::GkeMultiCloud::V1::AttachedCluster.

An Anthos cluster running on customer own infrastructure.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#authorization

def authorization() -> ::Google::Cloud::GkeMultiCloud::V1::AttachedClustersAuthorization

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AttachedClustersAuthorization) — Optional. Configuration related to the cluster RBAC settings.

#authorization=

def authorization=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AttachedClustersAuthorization

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AttachedClustersAuthorization) — Optional. Configuration related to the cluster RBAC settings.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AttachedClustersAuthorization) — Optional. Configuration related to the cluster RBAC settings.

#cluster_region

def cluster_region() -> ::String

Returns

• (::String) — Output only. The region where this cluster runs.

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

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time at which this cluster was registered.

#description

def description() -> ::String

Returns

• (::String) — Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

Returns

• (::String) — Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

#distribution

def distribution() -> ::String

Returns

• (::String) — Required. The Kubernetes distribution of the underlying attached cluster.

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

#distribution=

def distribution=(value) -> ::String

Parameter

• value (::String) — Required. The Kubernetes distribution of the underlying attached cluster.

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

Returns

• (::String) — Required. The Kubernetes distribution of the underlying attached cluster.

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

#errors

def errors() -> ::Array<::Google::Cloud::GkeMultiCloud::V1::AttachedClusterError>

Returns

• (::Array<::Google::Cloud::GkeMultiCloud::V1::AttachedClusterError>) — Output only. A set of errors found in the cluster.

#etag

def etag() -> ::String

Returns

• (::String) — 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.

#etag=

def etag=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#fleet

def fleet() -> ::Google::Cloud::GkeMultiCloud::V1::Fleet

Returns

• (::Google::Cloud::GkeMultiCloud::V1::Fleet) — Required. Fleet configuration.

#fleet=

def fleet=(value) -> ::Google::Cloud::GkeMultiCloud::V1::Fleet

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::Fleet) — Required. Fleet configuration.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::Fleet) — Required. Fleet configuration.

#kubernetes_version

def kubernetes_version() -> ::String

Returns

• (::String) — Output only. The Kubernetes version of the cluster.

#logging_config

def logging_config() -> ::Google::Cloud::GkeMultiCloud::V1::LoggingConfig

Returns

• (::Google::Cloud::GkeMultiCloud::V1::LoggingConfig) — Optional. Logging configuration for this cluster.

#logging_config=

def logging_config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::LoggingConfig

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::LoggingConfig) — Optional. Logging configuration for this cluster.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::LoggingConfig) — Optional. Logging configuration for this cluster.

#monitoring_config

def monitoring_config() -> ::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig

Returns

• (::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig) — Optional. Monitoring configuration for this cluster.

#monitoring_config=

def monitoring_config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig) — Optional. Monitoring configuration for this cluster.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig) — Optional. Monitoring configuration for this cluster.

#name

def name() -> ::String

Returns

• (::String) — 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.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#oidc_config

def oidc_config() -> ::Google::Cloud::GkeMultiCloud::V1::AttachedOidcConfig

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AttachedOidcConfig) — Required. OpenID Connect (OIDC) configuration for the cluster.

#oidc_config=

def oidc_config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AttachedOidcConfig

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AttachedOidcConfig) — Required. OpenID Connect (OIDC) configuration for the cluster.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AttachedOidcConfig) — Required. OpenID Connect (OIDC) configuration for the cluster.

#platform_version

def platform_version() -> ::String

Returns

• (::String) — 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.

#platform_version=

def platform_version=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#reconciling

def reconciling() -> ::Boolean

Returns

• (::Boolean) — Output only. If set, there are currently changes in flight to the cluster.

#state

def state() -> ::Google::Cloud::GkeMultiCloud::V1::AttachedCluster::State

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AttachedCluster::State) — Output only. The current state of the cluster.

#uid

def uid() -> ::String

Returns

• (::String) — Output only. A globally unique identifier for the cluster.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time at which this cluster was last updated.

#workload_identity_config

def workload_identity_config() -> ::Google::Cloud::GkeMultiCloud::V1::WorkloadIdentityConfig

Returns

• (::Google::Cloud::GkeMultiCloud::V1::WorkloadIdentityConfig) — Output only. Workload Identity settings.