Reference documentation and code samples for the Google Cloud Dataproc V1 Client class StartClusterRequest.
A request to start a cluster.
Generated from protobuf messagegoogle.cloud.dataproc.v1.StartClusterRequest
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 the cluster belongs to.
↳ region
string
Required. The Dataproc region in which to handle the request.
↳ cluster_name
string
Required. The cluster name.
↳ cluster_uuid
string
Optional. Specifying thecluster_uuidmeans the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.
↳ request_id
string
Optional. A unique ID used to identify the request. If the server receives twoStartClusterRequests with the same id, then the second request will be ignored and the firstgoogle.longrunning.Operationcreated and stored in the backend is returned. Recommendation: Set this value to aUUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
getProjectId
Required. The ID of the Google Cloud Platform project the
cluster belongs to.
Returns
Type
Description
string
setProjectId
Required. The ID of the Google Cloud Platform project 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
getClusterName
Required. The cluster name.
Returns
Type
Description
string
setClusterName
Required. The cluster name.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getClusterUuid
Optional. Specifying thecluster_uuidmeans the RPC will fail
(with error NOT_FOUND) if a cluster with the specified UUID does not exist.
Returns
Type
Description
string
setClusterUuid
Optional. Specifying thecluster_uuidmeans the RPC will fail
(with error NOT_FOUND) if a cluster with the specified UUID does not exist.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRequestId
Optional. A unique ID used to identify the request. If the server
receives twoStartClusterRequests
with the same id, then the second request will be ignored and the
firstgoogle.longrunning.Operationcreated
and stored in the backend is returned.
Recommendation: Set this value to aUUID.
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 twoStartClusterRequests
with the same id, then the second request will be ignored and the
firstgoogle.longrunning.Operationcreated
and stored in the backend is returned.
Recommendation: Set this value to aUUID.
The ID must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), and hyphens (-). The maximum length is 40 characters.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc V1 Client - Class StartClusterRequest (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.StartClusterRequest)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.StartClusterRequest)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.StartClusterRequest)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.StartClusterRequest)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.StartClusterRequest)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.StartClusterRequest)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.StartClusterRequest)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.StartClusterRequest)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.StartClusterRequest)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.StartClusterRequest)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.StartClusterRequest)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.StartClusterRequest)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.StartClusterRequest)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.StartClusterRequest)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.StartClusterRequest)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.StartClusterRequest)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.StartClusterRequest)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.StartClusterRequest)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.StartClusterRequest) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class StartClusterRequest.\n\nA request to start a cluster.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.StartClusterRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getProjectId\n\nRequired. The ID of the Google Cloud Platform project the\ncluster belongs to.\n\n### setProjectId\n\nRequired. The ID of the Google Cloud Platform project the\ncluster belongs to.\n\n### getRegion\n\nRequired. The Dataproc region in which to handle the request.\n\n### setRegion\n\nRequired. The Dataproc region in which to handle the request.\n\n### getClusterName\n\nRequired. The cluster name.\n\n### setClusterName\n\nRequired. The cluster name.\n\n### getClusterUuid\n\nOptional. Specifying the `cluster_uuid` means the RPC will fail\n(with error NOT_FOUND) if a cluster with the specified UUID does not exist.\n\n### setClusterUuid\n\nOptional. Specifying the `cluster_uuid` means the RPC will fail\n(with error NOT_FOUND) if a cluster with the specified UUID does not exist.\n\n### getRequestId\n\nOptional. A unique ID used to identify the request. If the server\nreceives two\n[StartClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s\nwith the same id, then the second request will be ignored and the\nfirst google.longrunning.Operation created\nand stored in the backend is returned.\n\nRecommendation: Set this value to a\n[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).\nThe ID must contain only letters (a-z, A-Z), numbers (0-9),\nunderscores (_), and hyphens (-). The maximum length is 40 characters.\n\n### setRequestId\n\nOptional. A unique ID used to identify the request. If the server\nreceives two\n[StartClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s\nwith the same id, then the second request will be ignored and the\nfirst google.longrunning.Operation created\nand stored in the backend is returned.\n\nRecommendation: Set this value to a\n[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).\nThe ID must contain only letters (a-z, A-Z), numbers (0-9),\nunderscores (_), and hyphens (-). The maximum length is 40 characters."]]
