REST Resource: projects.locations.privateClouds.clusters

Stay organized with collections Save and categorize content based on your preferences.

Resource: Cluster

A cluster in a private cloud.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "management": boolean,
  "uid": string,
  "nodeTypeConfigs": {
    string: {
      object (NodeTypeConfig)
    },
    ...
  }
}
Fields
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-west1-a/privateClouds/my-cloud/clusters/my-cluster

createTime

string (Timestamp format)

Output only. Creation time of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Last update time of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Output only. State of the resource.

management

boolean

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.

nodeTypeConfigs

map (key: string, value: object (NodeTypeConfig))

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

State

Enum State defines possible states of private cloud clusters.

Enums
STATE_UNSPECIFIED The default value. This value should never be used.
ACTIVE The Cluster is operational and can be used by the user.
CREATING The Cluster is being deployed.
UPDATING Adding or removing of a node to the cluster, any other cluster specific updates.
DELETING The Cluster is being deleted.
REPAIRING The Cluster is undergoing maintenance, for example: a failed node is getting replaced.

Methods

create

Creates a new cluster in a given private cloud.

delete

Deletes a Cluster resource.

get

Retrieves a Cluster resource by its resource name.

getIamPolicy

Gets the access control policy for a resource.

list

Lists Cluster resources in a given private cloud.

patch

Modifies a Cluster resource.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.