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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of this resource. Cluster names are formatted as |
↳ 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. |
↳ 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 |
Google\Cloud\GkeMultiCloud\V1\Fleet
Required. Fleet configuration. |
↳ 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 |
Google\Protobuf\Timestamp
Output only. The time at which this cluster was registered. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which this cluster was last updated. |
↳ 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 |
Google\Cloud\GkeMultiCloud\V1\WorkloadIdentityConfig
Output only. Workload Identity settings. |
↳ logging_config |
Google\Cloud\GkeMultiCloud\V1\LoggingConfig
Optional. Logging configuration for this cluster. |
↳ 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 |
Google\Cloud\GkeMultiCloud\V1\MonitoringConfig
Optional. Monitoring configuration for this cluster. |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOidcConfig
Required. OpenID Connect (OIDC) configuration for the cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AttachedOidcConfig|null |
|
hasOidcConfig
clearOidcConfig
setOidcConfig
Required. OpenID Connect (OIDC) configuration for the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AttachedOidcConfig
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDistribution
Required. The Kubernetes distribution of the underlying attached cluster.
Supported values: ["eks", "aks", "generic"].
| Returns | |
|---|---|
| Type | Description |
string |
|
setDistribution
Required. The Kubernetes distribution of the underlying attached cluster.
Supported values: ["eks", "aks", "generic"].
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFleet
Required. Fleet configuration.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\Fleet|null |
|
hasFleet
clearFleet
setFleet
Required. Fleet configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\Fleet
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the cluster.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The current state of the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. A globally unique identifier for the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. A globally unique identifier for the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReconciling
Output only. If set, there are currently changes in flight to the cluster.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReconciling
Output only. If set, there are currently changes in flight to the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which this cluster was registered.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this cluster was registered.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time at which this cluster was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this cluster was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKubernetesVersion
Output only. The Kubernetes version of the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKubernetesVersion
Output only. The Kubernetes version of the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkloadIdentityConfig
Output only. Workload Identity settings.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\WorkloadIdentityConfig|null |
|
hasWorkloadIdentityConfig
clearWorkloadIdentityConfig
setWorkloadIdentityConfig
Output only. Workload Identity settings.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\WorkloadIdentityConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoggingConfig
Optional. Logging configuration for this cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\LoggingConfig|null |
|
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. Logging configuration for this cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\LoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrors
Output only. A set of errors found in the cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setErrors
Output only. A set of errors found in the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\GkeMultiCloud\V1\AttachedClusterError>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthorization
Optional. Configuration related to the cluster RBAC settings.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AttachedClustersAuthorization|null |
|
hasAuthorization
clearAuthorization
setAuthorization
Optional. Configuration related to the cluster RBAC settings.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AttachedClustersAuthorization
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMonitoringConfig
Optional. Monitoring configuration for this cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\MonitoringConfig|null |
|
hasMonitoringConfig
clearMonitoringConfig
setMonitoringConfig
Optional. Monitoring configuration for this cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\MonitoringConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AttachedProxyConfig|null |
|
hasProxyConfig
clearProxyConfig
setProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AttachedProxyConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBinaryAuthorization
Optional. Binary Authorization configuration for this cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\BinaryAuthorization|null |
|
hasBinaryAuthorization
clearBinaryAuthorization
setBinaryAuthorization
Optional. Binary Authorization configuration for this cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\BinaryAuthorization
|
| Returns | |
|---|---|
| Type | Description |
$this |
|