You're seeing just the function dataproc_projects_regions_clusters_patch, go back to GoogleApi.Dataproc.V1.Api.Projects module for more information.
Link to this function

dataproc_projects_regions_clusters_patch(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ [])

View Source


) ::
  {:ok, GoogleApi.Dataproc.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (


  • connection (type: GoogleApi.Dataproc.V1.Connection.t) - Connection to server
  • project_id (type: String.t) - Required. The ID of the Google Cloud Platform project the cluster belongs to.
  • region (type: String.t) - Required. The Dataproc region in which to handle the request.
  • cluster_name (type: String.t) - Required. The cluster name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :gracefulDecommissionTimeout (type: String.t) - 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 ( supported on Dataproc image versions 1.2 and higher.
    • :requestId (type: String.t) - Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest ( 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 ( id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
    • :updateMask (type: String.t) - 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 config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies
    • :body (type: GoogleApi.Dataproc.V1.Model.Cluster.t) -
  • opts (type: keyword()) - Call options


  • {:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success
  • {:error, info} on failure