Google Cloud Dataproc V1 Client - Class UpdateClusterRequest (3.11.0)

Version 3.11.0

• 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 UpdateClusterRequest.

A request to update a cluster.

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

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	Google\Cloud\Dataproc\V1\Cluster Required. The changes to the cluster.
↳ graceful_decommission_timeout	Google\Protobuf\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\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: Mask Purpose labels Update labels config.worker_config.num_instances Resize primary worker group config.secondary_worker_config.num_instances Resize secondary worker group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies
↳ request_id	string Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequests 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.

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

getCluster

Required. The changes to the cluster.

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

hasCluster

clearCluster

setCluster

Required. The changes to the cluster.

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

Returns
Type	Description
$this

getGracefulDecommissionTimeout

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.

Returns
Type	Description
Google\Protobuf\Duration|null

hasGracefulDecommissionTimeout

clearGracefulDecommissionTimeout

setGracefulDecommissionTimeout

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.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getUpdateMask

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:

Mask	Purpose
labels	Update labels
config.worker_config.num_instances	Resize primary worker group
config.secondary_worker_config.num_instances	Resize secondary worker group
config.autoscaling_config.policy_uri	Use, stop using, or change autoscaling policies

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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:

Mask	Purpose
labels	Update labels
config.worker_config.num_instances	Resize primary worker group
config.secondary_worker_config.num_instances	Resize secondary worker group
config.autoscaling_config.policy_uri	Use, stop using, or change autoscaling policies

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getRequestId

Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequests 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 UpdateClusterRequests 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

static::build

Parameters
Name	Description
projectId	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.
clusterName	string Required. The cluster name.
cluster	Google\Cloud\Dataproc\V1\Cluster Required. The changes to the cluster.
updateMask	Google\Protobuf\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: Mask Purpose labels Update labels config.worker_config.num_instances Resize primary worker group config.secondary_worker_config.num_instances Resize secondary worker group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies

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