Google Cloud Dataproc V1 Client - Class UpdateClusterRequest (3.6.1)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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:

MaskPurpose
labelsUpdate labels
config.worker_config.num_instancesResize primary worker group
config.secondary_worker_config.num_instancesResize secondary worker group
config.autoscaling_config.policy_uriUse, 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
TypeDescription
string

setProjectId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRegion

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

Returns
TypeDescription
string

setRegion

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClusterName

Required. The cluster name.

Returns
TypeDescription
string

setClusterName

Required. The cluster name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCluster

Required. The changes to the cluster.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\Cluster|null

hasCluster

clearCluster

setCluster

Required. The changes to the cluster.

Parameter
NameDescription
var Google\Cloud\Dataproc\V1\Cluster
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$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:

MaskPurpose
labelsUpdate labels
config.worker_config.num_instancesResize primary worker group
config.secondary_worker_config.num_instancesResize secondary worker group
config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies

Returns
TypeDescription
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:

MaskPurpose
labelsUpdate labels
config.worker_config.num_instancesResize primary worker group
config.secondary_worker_config.num_instancesResize secondary worker group
config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this