Google Cloud Vmware Engine V1 Client - Class Cluster (0.5.6)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class Cluster.

A cluster in a private cloud.

Generated from protobuf message google.cloud.vmwareengine.v1.Cluster

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

↳ create_time Google\Protobuf\Timestamp

Output only. Creation time of this resource.

↳ update_time Google\Protobuf\Timestamp

Output only. Last update time of this resource.

↳ state int

Output only. State of the resource.

↳ management bool

Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.

↳ uid string

Output only. System-generated unique identifier for the resource.

↳ node_type_configs array|Google\Protobuf\Internal\MapField

Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).

↳ stretched_cluster_config Google\Cloud\VmwareEngine\V1\StretchedClusterConfig

Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.

getName

Output only. The resource name of this cluster.

Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

Returns
Type Description
string

setName

Output only. The resource name of this cluster.

Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Creation time of this resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of this resource.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Last update time of this resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update time of this resource.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. State of the resource.

Returns
Type Description
int

setState

Output only. State of the resource.

Parameter
Name Description
var int
Returns
Type Description
$this

getManagement

Output only. True if the cluster is a management cluster; false otherwise.

There can only be one management cluster in a private cloud and it has to be the first one.

Returns
Type Description
bool

setManagement

Output only. True if the cluster is a management cluster; false otherwise.

There can only be one management cluster in a private cloud and it has to be the first one.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUid

Output only. System-generated unique identifier for the resource.

Returns
Type Description
string

setUid

Output only. System-generated unique identifier for the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getNodeTypeConfigs

Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).

Returns
Type Description
Google\Protobuf\Internal\MapField

setNodeTypeConfigs

Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getStretchedClusterConfig

Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.

Returns
Type Description
Google\Cloud\VmwareEngine\V1\StretchedClusterConfig|null

hasStretchedClusterConfig

clearStretchedClusterConfig

setStretchedClusterConfig

Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.

Parameter
Name Description
var Google\Cloud\VmwareEngine\V1\StretchedClusterConfig
Returns
Type Description
$this