Struct gcp_client::google::cloud::dataproc::v1beta2::UpdateClusterRequest

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,
}

A request to update a cluster.

Fields

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

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

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

request_id: String

Optional. A unique id used to identify the request. If the server receives two [UpdateClusterRequest][google.cloud.dataproc.v1beta2.UpdateClusterRequest] requests with the same id, then the second request will be ignored and the first [google.longrunning.Operation][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.

Trait Implementations

impl Clone for UpdateClusterRequest

fn clone(&self) -> UpdateClusterRequest

Returns a copy 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 encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<UpdateClusterRequest> for UpdateClusterRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for UpdateClusterRequest