clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	google.vmwareengine.clusters

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. 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
autoscalingSettings	object	Optional. Configuration of the autoscaling applied to this cluster. (id: AutoscalingSettings)
createTime	string (google-datetime)	Output only. Creation time of this 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.
nodeTypeConfigs	object	Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
state	string	Output only. State of the resource.
stretchedClusterConfig	object	Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud. (id: StretchedClusterConfig)
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. 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
autoscalingSettings	object	Optional. Configuration of the autoscaling applied to this cluster. (id: AutoscalingSettings)
createTime	string (google-datetime)	Output only. Creation time of this 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.
nodeTypeConfigs	object	Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
state	string	Output only. State of the resource.
stretchedClusterConfig	object	Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud. (id: StretchedClusterConfig)
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateCloudsId, clustersId		Retrieves a Cluster resource by its resource name.
list	select	projectsId, locationsId, privateCloudsId	pageSize, pageToken, filter, orderBy	Lists Cluster resources in a given private cloud.
create	insert	projectsId, locationsId, privateCloudsId	clusterId, requestId, validateOnly	Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.
patch	update	projectsId, locationsId, privateCloudsId, clustersId	updateMask, requestId, validateOnly	Modifies a Cluster resource. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
delete	delete	projectsId, locationsId, privateCloudsId, clustersId	requestId	Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clustersId	string
locationsId	string
privateCloudsId	string
projectsId	string
clusterId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Retrieves a Cluster resource by its resource name.

SELECT
name,
autoscalingSettings,
createTime,
management,
nodeTypeConfigs,
state,
stretchedClusterConfig,
uid,
updateTime
FROM google.vmwareengine.clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required;

list

Lists Cluster resources in a given private cloud.

SELECT
name,
autoscalingSettings,
createTime,
management,
nodeTypeConfigs,
state,
stretchedClusterConfig,
uid,
updateTime
FROM google.vmwareengine.clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.

INSERT INTO google.vmwareengine.clusters (
data__autoscalingSettings,
data__nodeTypeConfigs,
data__stretchedClusterConfig,
projectsId,
locationsId,
privateCloudsId,
clusterId,
requestId,
validateOnly
)
SELECT 
'{{ autoscalingSettings }}',
'{{ nodeTypeConfigs }}',
'{{ stretchedClusterConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateCloudsId }}',
'{{ clusterId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the clusters resource.
    - name: privateCloudsId
      value: string
      description: Required parameter for the clusters resource.
    - name: autoscalingSettings
      value: object
      description: >
        Optional. Configuration of the autoscaling applied to this cluster.
        
    - name: nodeTypeConfigs
      value: object
      description: >
        Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`).
        
    - name: stretchedClusterConfig
      value: object
      description: >
        Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
        
    - name: clusterId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Modifies a Cluster resource. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

UPDATE google.vmwareengine.clusters
SET 
data__autoscalingSettings = '{{ autoscalingSettings }}',
data__nodeTypeConfigs = '{{ nodeTypeConfigs }}',
data__stretchedClusterConfig = '{{ stretchedClusterConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.

DELETE FROM google.vmwareengine.clusters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND requestId = '{{ requestId }}';