Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AttachedCluster.
An Anthos cluster running on customer own infrastructure.
Generated from protobuf message google.cloud.gkemulticloud.v1.AttachedCluster
Namespace
Google \ Cloud \ GkeMultiCloud \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
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.
↳ description
string
Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.
↳ oidc_config
Google\Cloud\GkeMultiCloud\V1\AttachedOidcConfig
Required. OpenID Connect (OIDC) configuration for the cluster.
↳ platform_version
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
.
↳ distribution
string
Required. The Kubernetes distribution of the underlying attached cluster. Supported values: ["eks", "aks", "generic"].
↳ cluster_region
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.
↳ fleet
↳ state
int
Output only. The current state of the cluster.
↳ uid
string
Output only. A globally unique identifier for the cluster.
↳ reconciling
bool
Output only. If set, there are currently changes in flight to the cluster.
↳ create_time
↳ update_time
↳ etag
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.
↳ kubernetes_version
string
Output only. The Kubernetes version of the cluster.
↳ annotations
array| Google\Protobuf\Internal\MapField
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.
↳ workload_identity_config
↳ logging_config
↳ errors
array< Google\Cloud\GkeMultiCloud\V1\AttachedClusterError
>
Output only. A set of errors found in the cluster.
↳ authorization
Google\Cloud\GkeMultiCloud\V1\AttachedClustersAuthorization
Optional. Configuration related to the cluster RBAC settings.
↳ monitoring_config
↳ proxy_config
Google\Cloud\GkeMultiCloud\V1\AttachedProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
↳ binary_authorization
Google\Cloud\GkeMultiCloud\V1\BinaryAuthorization
Optional. Binary Authorization configuration for this cluster.
getName
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.
string
setName
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.
var
string
$this
getDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
string
setDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
var
string
$this
getOidcConfig
Required. OpenID Connect (OIDC) configuration for the cluster.
hasOidcConfig
clearOidcConfig
setOidcConfig
Required. OpenID Connect (OIDC) configuration for the cluster.
$this
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 .
string
setPlatformVersion
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 .
var
string
$this
getDistribution
Required. The Kubernetes distribution of the underlying attached cluster.
Supported values: ["eks", "aks", "generic"].
string
setDistribution
Required. The Kubernetes distribution of the underlying attached cluster.
Supported values: ["eks", "aks", "generic"].
var
string
$this
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
setClusterRegion
Output only. The region where this cluster runs.
For EKS clusters, this is a AWS region. For AKS clusters, this is an Azure region.
var
string
$this
getFleet
Required. Fleet configuration.
hasFleet
clearFleet
setFleet
Required. Fleet configuration.
$this
getState
Output only. The current state of the cluster.
int
setState
Output only. The current state of the cluster.
var
int
$this
getUid
Output only. A globally unique identifier for the cluster.
string
setUid
Output only. A globally unique identifier for the cluster.
var
string
$this
getReconciling
Output only. If set, there are currently changes in flight to the cluster.
bool
setReconciling
Output only. If set, there are currently changes in flight to the cluster.
var
bool
$this
getCreateTime
Output only. The time at which this cluster was registered.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this cluster was registered.
$this
getUpdateTime
Output only. The time at which this cluster was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this cluster was last updated.
$this
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
setEtag
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.
var
string
$this
getKubernetesVersion
Output only. The Kubernetes version of the cluster.
string
setKubernetesVersion
Output only. The Kubernetes version of the cluster.
var
string
$this
getAnnotations
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.
setAnnotations
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.
$this
getWorkloadIdentityConfig
Output only. Workload Identity settings.
hasWorkloadIdentityConfig
clearWorkloadIdentityConfig
setWorkloadIdentityConfig
Output only. Workload Identity settings.
$this
getLoggingConfig
Optional. Logging configuration for this cluster.
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. Logging configuration for this cluster.
$this
getErrors
Output only. A set of errors found in the cluster.
setErrors
Output only. A set of errors found in the cluster.
$this
getAuthorization
Optional. Configuration related to the cluster RBAC settings.
hasAuthorization
clearAuthorization
setAuthorization
Optional. Configuration related to the cluster RBAC settings.
$this
getMonitoringConfig
Optional. Monitoring configuration for this cluster.
hasMonitoringConfig
clearMonitoringConfig
setMonitoringConfig
Optional. Monitoring configuration for this cluster.
$this
getProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
hasProxyConfig
clearProxyConfig
setProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
$this
getBinaryAuthorization
Optional. Binary Authorization configuration for this cluster.
hasBinaryAuthorization
clearBinaryAuthorization
setBinaryAuthorization
Optional. Binary Authorization configuration for this cluster.
$this
