Struct UpdateClusterRequest 

#[non_exhaustive]
pub struct UpdateClusterRequest {
    pub project_id: String,
    pub region: String,
    pub cluster_name: String,
    pub cluster: Option<Cluster>,
    pub graceful_decommission_timeout: Option<Duration>,
    pub update_mask: Option<FieldMask>,
    pub request_id: String,
    /* private fields */
}

A request to update a cluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: Option<Cluster>

Required. The changes to the cluster.

graceful_decommission_timeout: Option<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: Option<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"
    }
  }
}

<strong>Note:</strong> Currently, only the following fields can be updated:

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.

Implementations

impl UpdateClusterRequest

pub fn new() -> Self

pub fn set_project_id<T: Into<String>>(self, v: T) -> Self

Sets the value of project_id.

pub fn set_region<T: Into<String>>(self, v: T) -> Self

Sets the value of region.

pub fn set_cluster_name<T: Into<String>>(self, v: T) -> Self

Sets the value of cluster_name.

pub fn set_cluster<T>(self, v: T) -> Self

where T: Into<Cluster>,

Sets the value of cluster.

pub fn set_or_clear_cluster<T>(self, v: Option<T>) -> Self

where T: Into<Cluster>,

Sets or clears the value of cluster.

pub fn set_graceful_decommission_timeout<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of graceful_decommission_timeout.

pub fn set_or_clear_graceful_decommission_timeout<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of graceful_decommission_timeout.

pub fn set_update_mask<T>(self, v: T) -> Self

where T: Into<FieldMask>,

Sets the value of update_mask.

pub fn set_or_clear_update_mask<T>(self, v: Option<T>) -> Self

where T: Into<FieldMask>,

Sets or clears the value of update_mask.

pub fn set_request_id<T: Into<String>>(self, v: T) -> Self

Sets the value of request_id.

Trait Implementations

impl Clone for UpdateClusterRequest

fn clone(&self) -> UpdateClusterRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateClusterRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UpdateClusterRequest

fn default() -> UpdateClusterRequest

Returns the “default value” for a type.

impl Message for UpdateClusterRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UpdateClusterRequest

fn eq(&self, other: &UpdateClusterRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateClusterRequest