Google Cloud Vmware Engine V1 Client - Class CreateClusterRequest (1.1.0)

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

Request message for VmwareEngine.CreateCluster

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

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the private cloud to create a new cluster in. 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
↳ cluster_id string

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with RFC 1034 (section 3.5)
↳ cluster Google\Cloud\VmwareEngine\V1\Cluster

Required. The initial description of the new cluster.
↳ request_id string

Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ validate_only bool

Optional. True if you want the request to be validated and not executed; false otherwise.

getParent

Required. The resource name of the private cloud to create a new cluster in. 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

Returns
Type Description
string

setParent

Required. The resource name of the private cloud to create a new cluster in. 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

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterId

Required. The user-provided identifier of the new Cluster.

This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
Returns
Type Description
string

setClusterId

Required. The user-provided identifier of the new Cluster.

This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
Parameter
Name Description
var string
Returns
Type Description
$this

getCluster

Required. The initial description of the new cluster.

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

hasCluster

clearCluster

setCluster

Required. The initial description of the new cluster.

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

getRequestId

Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. True if you want the request to be validated and not executed; false otherwise.

Returns
Type Description
bool

setValidateOnly

Optional. True if you want the request to be validated and not executed; false otherwise.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The resource name of the private cloud to create a new cluster in. 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 Please see Google\Cloud\VmwareEngine\V1\VmwareEngineClient::privateCloudName() for help formatting this field.
cluster Google\Cloud\VmwareEngine\V1\Cluster

Required. The initial description of the new cluster.
clusterId string

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
Returns
Type Description
Google\Cloud\VmwareEngine\V1\CreateClusterRequest