Class: Google::Cloud::Dataproc::V1::UpdateClusterRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataproc/v1/clusters.rb

Overview

A request to update a cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#cluster ⇒ ::Google::Cloud::Dataproc::V1::Cluster

Returns Required. The changes to the cluster.

Returns:



1356
1357
1358
1359
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1356

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#cluster_name ⇒ ::String

Returns Required. The cluster name.

Returns:

  • (::String) —

    Required. The cluster name.



1356
1357
1358
1359
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1356

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#graceful_decommission_timeout ⇒ ::Google::Protobuf::Duration

Returns 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.



1356
1357
1358
1359
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1356

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#project_id ⇒ ::String

Returns 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.



1356
1357
1358
1359
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1356

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#region ⇒ ::String

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

Returns:

  • (::String) —

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



1356
1357
1358
1359
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1356

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_id ⇒ ::String

Returns 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.



1356
1357
1358
1359
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1356

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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_uriUse, stop using, or change autoscaling policies
.

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_uriUse, stop using, or change autoscaling policies 



1356
1357
1358
1359
 
# File 'proto_docs/google/cloud/dataproc/v1/clusters.rb', line 1356

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end