dataproc.projects.regions.clusters.patch

PATCH {{baseUrl}}/v1/projects/:projectId/regions/:region/clusters/:clusterName?gracefulDecommissionTimeout=<string>&requestId=<string>&updateMask=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

Request Params

KeyDatatypeRequiredDescription
gracefulDecommissionTimeoutstringOptional. 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 (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.
requestIdstringOptional. 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.
updateMaskstringRequired. 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
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI 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_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"clusterName"=>"<string>", "config"=>{"autoscalingConfig"=>{"policyUri"=>"elit sint eiusmod"}, "configBucket"=>"eu elit fugiat minim", "encryptionConfig"=>{"gcePdKmsKeyName"=>"non"}, "endpointConfig"=>{"enableHttpPortAccess"=>false}, "gceClusterConfig"=>{"internalIpOnly"=>false, "networkUri"=>"consequat dolore", "nodeGroupAffinity"=>{"nodeGroupUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "privateIpv6GoogleAccess"=>"PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", "reservationAffinity"=>{"consumeReservationType"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "key"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "values"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "serviceAccount"=>"fugiat", "serviceAccountScopes"=>["deserunt aliquip voluptate elit", "ullamco consectetur"], "subnetworkUri"=>"esse", "tags"=>["veniam dolor ut qui", "reprehenderit ipsum"], "zoneUri"=>"reprehenderit sed"}, "initializationActions"=>[{"executableFile"=>"non quis", "executionTimeout"=>"proident velit dolor do elit"}, {"executableFile"=>"ea do", "executionTimeout"=>"proident in"}], "lifecycleConfig"=>{"autoDeleteTime"=>"do non tempor", "autoDeleteTtl"=>"occaecat eu", "idleDeleteTtl"=>"ad fugiat tempor sed", "idleStartTime"=>"proident est ex veniam"}, "masterConfig"=>{"accelerators"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "diskConfig"=>{"bootDiskSizeGb"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "bootDiskType"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "numLocalSsds"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "imageUri"=>"ipsum officia proident veniam", "instanceNames"=>["eu sed", "in"], "instanceReferences"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "isPreemptible"=>true, "machineTypeUri"=>"adipisicing anim tempor velit ad", "managedGroupConfig"=>{"instanceGroupManagerName"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "instanceTemplateName"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "minCpuPlatform"=>"laborum anim Ut", "numInstances"=>40838152, "preemptibility"=>"PREEMPTIBILITY_UNSPECIFIED"}, "secondaryWorkerConfig"=>{"accelerators"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "diskConfig"=>{"bootDiskSizeGb"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "bootDiskType"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "numLocalSsds"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "imageUri"=>"do incididunt sed Ut", "instanceNames"=>["ad velit nostrud", "consectetur nulla"], "instanceReferences"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "isPreemptible"=>true, "machineTypeUri"=>"in aliqua elit est et", "managedGroupConfig"=>{"instanceGroupManagerName"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "instanceTemplateName"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "minCpuPlatform"=>"eu ad et", "numInstances"=>-41434615, "preemptibility"=>"PREEMPTIBILITY_UNSPECIFIED"}, "securityConfig"=>{"kerberosConfig"=>{"crossRealmTrustAdminServer"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "crossRealmTrustKdc"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "crossRealmTrustRealm"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "crossRealmTrustSharedPasswordUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "enableKerberos"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "kdcDbKeyUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "keyPasswordUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "keystorePasswordUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "keystoreUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "kmsKeyUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "realm"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "rootPrincipalPasswordUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "tgtLifetimeHours"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "truststorePasswordUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "truststoreUri"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "softwareConfig"=>{"imageVersion"=>"proident in ea", "optionalComponents"=>["RANGER", "DOCKER"]}, "tempBucket"=>"dolor dolor velit", "workerConfig"=>{"accelerators"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "diskConfig"=>{"bootDiskSizeGb"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "bootDiskType"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "numLocalSsds"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "imageUri"=>"dolore eu", "instanceNames"=>["veniam sit", "fugiat Excepteur"], "instanceReferences"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "isPreemptible"=>false, "machineTypeUri"=>"fugiat qui ea exercitation", "managedGroupConfig"=>{"instanceGroupManagerName"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "instanceTemplateName"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "minCpuPlatform"=>"ipsum dolor", "numInstances"=>53165135, "preemptibility"=>"NON_PREEMPTIBLE"}}, "labels"=>"<object>", "projectId"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;done&quot;:false,&quot;error&quot;:{&quot;code&quot;:56876691,&quot;message&quot;:&quot;esse ea proident&quot;},&quot;metadata&quot;:{},&quot;name&quot;:&quot;voluptate Lorem&quot;,&quot;response&quot;:{}}