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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dataproc/v1/doc/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:



466
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 466

class UpdateClusterRequest; end

#cluster_name ⇒ String

Returns Required. The cluster name.

Returns:

  • (String) —

    Required. The cluster name.



466
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 466

class UpdateClusterRequest; 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.



466
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 466

class UpdateClusterRequest; end

#region ⇒ String

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

Returns:

  • (String) —

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



466
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 466

class UpdateClusterRequest; 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

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 



466
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb', line 466

class UpdateClusterRequest; end