Struct google_dataproc1::ProjectRegionClusterPatchCall

pub struct ProjectRegionClusterPatchCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Updates a cluster in a project.

A builder for the regions.clusters.patch method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

Example

Instantiate a resource method builder

use dataproc1::Cluster;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Cluster::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().regions_clusters_patch(req, "projectId", "region", "clusterName")
             .update_mask("sea")
             .request_id("Lorem")
             .graceful_decommission_timeout("eos")
             .doit();

Methods

impl<'a, C, A> ProjectRegionClusterPatchCall<'a, C, A> where     C: BorrowMut<Client>,     A: GetToken,

pub fn doit(self) -> Result<(Response, Operation)>

Perform the operation you have build so far.

pub fn request(     self,     new_value: Cluster ) -> ProjectRegionClusterPatchCall<'a, C, A>

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn project_id(     self,     new_value: &str ) -> ProjectRegionClusterPatchCall<'a, C, A>

Required. The ID of the Google Cloud Platform project the cluster belongs to.

Sets the project id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn region(self, new_value: &str) -> ProjectRegionClusterPatchCall<'a, C, A>

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

Sets the region path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn cluster_name(     self,     new_value: &str ) -> ProjectRegionClusterPatchCall<'a, C, A>

Required. The cluster name.

Sets the cluster name path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn update_mask(     self,     new_value: &str ) -> ProjectRegionClusterPatchCall<'a, C, A>

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

Sets the update mask query property to the given value.

pub fn request_id(     self,     new_value: &str ) -> ProjectRegionClusterPatchCall<'a, C, A>

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 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Sets the request id query property to the given value.

pub fn graceful_decommission_timeout(     self,     new_value: &str ) -> ProjectRegionClusterPatchCall<'a, C, A>

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.Only supported on Dataproc image versions 1.2 and higher.

Sets the graceful decommission timeout query property to the given value.

pub fn delegate(     self,     new_value: &'a mut Delegate ) -> ProjectRegionClusterPatchCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(     self,     name: T,     value: T ) -> ProjectRegionClusterPatchCall<'a, C, A> where     T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(     self,     scope: T ) -> ProjectRegionClusterPatchCall<'a, C, A> where     T: Into<Option<S>>,     S: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for ProjectRegionClusterPatchCall<'a, C, A>