Google Cloud Dataproc V1 Client - Class CreateNodeGroupRequest (2.1.0)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class CreateNodeGroupRequest.

A request to create a node group.

Generated from protobuf message google.cloud.dataproc.v1.CreateNodeGroupRequest

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster}

↳ node_group Google\Cloud\Dataproc\V1\NodeGroup

Required. The node group to create.

↳ node_group_id string

Optional. An optional node group ID. Generated if not specified. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.

↳ request_id string

Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned. Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

getParent

Required. The parent resource where this node group will be created.

Format: projects/{project}/regions/{region}/clusters/{cluster}

Returns
Type Description
string

setParent

Required. The parent resource where this node group will be created.

Format: projects/{project}/regions/{region}/clusters/{cluster}

Parameter
Name Description
var string
Returns
Type Description
$this

getNodeGroup

Required. The node group to create.

Returns
Type Description
Google\Cloud\Dataproc\V1\NodeGroup|null

hasNodeGroup

clearNodeGroup

setNodeGroup

Required. The node group to create.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\NodeGroup
Returns
Type Description
$this

getNodeGroupId

Optional. An optional node group ID. Generated if not specified.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.

Returns
Type Description
string

setNodeGroupId

Optional. An optional node group ID. Generated if not specified.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Returns
Type Description
string

setRequestId

Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster} Please see Google\Cloud\Dataproc\V1\NodeGroupControllerClient::clusterRegionName() for help formatting this field.

nodeGroup Google\Cloud\Dataproc\V1\NodeGroup

Required. The node group to create.

nodeGroupId string

Optional. An optional node group ID. Generated if not specified.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.

Returns
Type Description
Google\Cloud\Dataproc\V1\CreateNodeGroupRequest