Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::UpdateClusterRequest (v0.25.0)

Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::UpdateClusterRequest.

A request to update a cluster.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#cluster

def cluster() -> ::Google::Cloud::Dataproc::V1::Cluster

Returns

(::Google::Cloud::Dataproc::V1::Cluster) — Required. The changes to the cluster.

#cluster=

def cluster=(value) -> ::Google::Cloud::Dataproc::V1::Cluster

Parameter

value (::Google::Cloud::Dataproc::V1::Cluster) — Required. The changes to the cluster.

Returns

(::Google::Cloud::Dataproc::V1::Cluster) — Required. The changes to the cluster.

#cluster_name

def cluster_name() -> ::String

Returns

(::String) — Required. The cluster name.

#cluster_name=

def cluster_name=(value) -> ::String

Parameter

value (::String) — Required. The cluster name.

Returns

(::String) — Required. The cluster name.

#graceful_decommission_timeout

def graceful_decommission_timeout() -> ::Google::Protobuf::Duration

Returns

(::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.

#graceful_decommission_timeout=

def graceful_decommission_timeout=(value) -> ::Google::Protobuf::Duration

Parameter

value (::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.

Returns

(::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.

#project_id

def project_id() -> ::String

Returns

(::String) — Required. The ID of the Google Cloud Platform project the cluster belongs to.

#project_id=

def project_id=(value) -> ::String

Parameter

value (::String) — Required. The ID of the Google Cloud Platform project the cluster belongs to.

Returns

(::String) — Required. The ID of the Google Cloud Platform project the cluster belongs to.

#region

def region() -> ::String

Returns

(::String) — Required. The Dataproc region in which to handle the request.

#region=

def region=(value) -> ::String

Parameter

value (::String) — Required. The Dataproc region in which to handle the request.

Returns

(::String) — Required. The Dataproc region in which to handle the request.

#request_id

def request_id() -> ::String

Returns

(::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.

#request_id=

def request_id=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask

Returns

(::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

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::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"
    }
  }
}

{
  "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

{
  "config":{
    "workerConfig":{
      "numInstances":"5"
    }
  }
}

{
  "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