- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Updates a cluster in a project. The returned Operation.metadata
will be ClusterOperationMetadata.
HTTP request
PATCH https://dataproc.googleapis.com/v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
projectId |
Required. The ID of the Google Cloud Platform project the cluster belongs to. |
region |
Required. The Cloud Dataproc region in which to handle the request. |
clusterName |
Required. The cluster name. |
Query parameters
Parameters | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
gracefulDecommissionTimeout |
Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. Only supported on Dataproc image versions 1.2 and higher. |
||||||||||||||||
updateMask |
Required. Specifies the path, relative to
Similarly, to change the number of preemptible workers in a cluster to 5, the
Note: currently only the following fields can be updated:
A comma-separated list of fully qualified names of fields. Example: |
||||||||||||||||
requestId |
Optional. A unique id used to identify the request. If the server receives two 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. |
Request body
The request body contains an instance of Cluster
.
Response body
If successful, the response body contains an instance of Operation
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.