Class: Google::Cloud::Dataproc::V1beta2::UpdateClusterRequest

Inherits:

Object

• Object
• Google::Cloud::Dataproc::V1beta2::UpdateClusterRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dataproc/v1beta2/clusters.rb

Overview

A request to update a cluster.

Instance Attribute Summary

• #cluster ⇒ ::Google::Cloud::Dataproc::V1beta2::Cluster

  Required.

• #cluster_name ⇒ ::String

  Required.

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

  Optional.

• #project_id ⇒ ::String

  Required.

• #region ⇒ ::String

  Required.

• #request_id ⇒ ::String

  Optional.

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

  Required.

Instance Attribute Details

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

Returns Required. The changes to the cluster.

Returns:

• (::Google::Cloud::Dataproc::V1beta2::Cluster) —

  Required. The changes to the cluster.

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 907

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.

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 907

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

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

Returns Optional. Timeout for graceful YARN decomissioning. 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 decomissioning. 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.

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 907

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.

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 907

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.

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 907

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

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 907

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	Updates labels
config.worker_config.num_instances	Resize primary worker group
config.secondary_worker_config.num_instances	Resize secondary worker group
config.lifecycle_config.auto_delete_ttl	Reset MAX TTL duration
config.lifecycle_config.auto_delete_time	Update MAX TTL deletion timestamp
config.lifecycle_config.idle_delete_ttl	Update Idle TTL duration
config.autoscaling_config.policy_uri	Use, 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	Updates labels
  config.worker_config.num_instances	Resize primary worker group
  config.secondary_worker_config.num_instances	Resize secondary worker group
  config.lifecycle_config.auto_delete_ttl	Reset MAX TTL duration
  config.lifecycle_config.auto_delete_time	Update MAX TTL deletion timestamp
  config.lifecycle_config.idle_delete_ttl	Update Idle TTL duration
  config.autoscaling_config.policy_uri	Use, stop using, or change autoscaling policies

# File 'proto_docs/google/cloud/dataproc/v1beta2/clusters.rb', line 907

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