Google Cloud Dataproc V1 Client - Class CreateClusterRequest (3.8.1)

Version 3.8.1

• 3.14.0 (latest)
• 3.13.4
• 3.12.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.8.1
• 3.7.1
• 3.6.1
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.2
• 2.2.1
• 2.1.0
• 2.0.0

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

A request to create a cluster.

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ project_id	string Required. The ID of the Google Cloud Platform project that the cluster belongs to.
↳ region	string Required. The Dataproc region in which to handle the request.
↳ cluster	Google\Cloud\Dataproc\V1\Cluster Required. The cluster to create.
↳ request_id	string Optional. A unique ID used to identify the request. If the server receives two CreateClusterRequests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned. It is recommended to always 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.
↳ action_on_failed_primary_workers	int Optional. Failure action when primary worker creation fails.

getProjectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

Returns
Type	Description
string

setProjectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRegion

Required. The Dataproc region in which to handle the request.

Returns
Type	Description
string

setRegion

Required. The Dataproc region in which to handle the request.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCluster

Required. The cluster to create.

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

hasCluster

clearCluster

setCluster

Required. The cluster to create.

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\Cluster

Returns
Type	Description
$this

getRequestId

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

It is recommended to always 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 CreateClusterRequests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.

It is recommended to always 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

getActionOnFailedPrimaryWorkers

Optional. Failure action when primary worker creation fails.

Returns
Type	Description
int

setActionOnFailedPrimaryWorkers

Optional. Failure action when primary worker creation fails.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

static::build

Parameters
Name	Description
projectId	string Required. The ID of the Google Cloud Platform project that the cluster belongs to.
region	string Required. The Dataproc region in which to handle the request.
cluster	Google\Cloud\Dataproc\V1\Cluster Required. The cluster to create.

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