UpdateClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)A request to update a cluster.
Attributes |
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Description | ||||||||||
project_id |
str
Required. The ID of the Google Cloud Platform project the cluster belongs to. |
||||||||||
region |
str
Required. The Dataproc region in which to handle the request. |
||||||||||
cluster_name |
str
Required. The cluster name. |
||||||||||
cluster |
google.cloud.dataproc_v1.types.Cluster
Required. The changes to the cluster. |
||||||||||
graceful_decommission_timeout |
google.protobuf.duration_pb2.Duration
Optional. Timeout for graceful YARN decommissioning. 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. (see JSON representation of Duration __).
Only supported on Dataproc image versions 1.2 and higher.
|
||||||||||
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Specifies the path, relative to Cluster, of
the field to update. For example, to change the number of
workers in a cluster to 5, the update_mask parameter
would be specified as
config.worker_config.num_instances, and the PATCH
request body would specify the new value, as follows:
::
{
"config":{
"workerConfig":{
"numInstances":"5"
}
}
}
Similarly, to change the number of preemptible workers in a
cluster to 5, the update_mask parameter would be
config.secondary_worker_config.num_instances, and the
PATCH request body would be set as follows:
::
{
"config":{
"secondaryWorkerConfig":{
"numInstances":"5"
}
}
}
Note: Currently, only the following fields can be updated:
.. raw:: html
|
||||||||||
request_id |
str
Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequest __\ s
with the same id, then the second request will be ignored
and the first
google.longrunning.Operation][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.
|
||||||||||