Dataproc.Projects.Regions.Clusters.Patch (Cloud Dataproc API v1beta2-rev20210825-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.dataproc.v1beta2.DataprocRequest<Operation>
        
        com.google.api.services.dataproc.v1beta2.Dataproc.Projects.Regions.Clusters.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataproc.Projects.Regions.Clusters
```
public class Dataproc.Projects.Regions.Clusters.Patch
extends DataprocRequest<Operation>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Patch(String projectId, String region, String clusterName, Cluster content)
Updates a cluster in a project.

Constructors
Modifier	Constructor and Description
`protected`	`Patch(String projectId, String region, String clusterName, Cluster content)` Updates a cluster in a project.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getClusterName()` Required.
`String`	`getGracefulDecommissionTimeout()` Optional.
`String`	`getProjectId()` Required.
`String`	`getRegion()` Required.
`String`	`getRequestId()` Optional.
`String`	`getUpdateMask()` Required.
`Dataproc.Projects.Regions.Clusters.Patch`	`set(String parameterName, Object value)`
`Dataproc.Projects.Regions.Clusters.Patch`	`set$Xgafv(String $Xgafv)` V1 error format.
`Dataproc.Projects.Regions.Clusters.Patch`	`setAccessToken(String accessToken)` OAuth access token.
`Dataproc.Projects.Regions.Clusters.Patch`	`setAlt(String alt)` Data format for response.
`Dataproc.Projects.Regions.Clusters.Patch`	`setCallback(String callback)` JSONP
`Dataproc.Projects.Regions.Clusters.Patch`	`setClusterName(String clusterName)` Required.
`Dataproc.Projects.Regions.Clusters.Patch`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dataproc.Projects.Regions.Clusters.Patch`	`setGracefulDecommissionTimeout(String gracefulDecommissionTimeout)` Optional.
`Dataproc.Projects.Regions.Clusters.Patch`	`setKey(String key)` API key.
`Dataproc.Projects.Regions.Clusters.Patch`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dataproc.Projects.Regions.Clusters.Patch`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dataproc.Projects.Regions.Clusters.Patch`	`setProjectId(String projectId)` Required.
`Dataproc.Projects.Regions.Clusters.Patch`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Dataproc.Projects.Regions.Clusters.Patch`	`setRegion(String region)` Required.
`Dataproc.Projects.Regions.Clusters.Patch`	`setRequestId(String requestId)` Optional.
`Dataproc.Projects.Regions.Clusters.Patch`	`setUpdateMask(String updateMask)` Required.
`Dataproc.Projects.Regions.Clusters.Patch`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Dataproc.Projects.Regions.Clusters.Patch`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dataproc.v1beta2.DataprocRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Patch
```
protected Patch(String projectId,
                String region,
                String clusterName,
                Cluster content)
```
    Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dat aproc.v1beta2#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned. Create a request for the method "clusters.patch". This request holds the parameters needed by the the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Dataproc.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    projectId - Required. The ID of the Google Cloud Platform project the cluster belongs to.
    
    region - Required. The Dataproc region in which to handle the request.
    
    clusterName - Required. The cluster name.
    
    content - the Cluster
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Dataproc.Projects.Regions.Clusters.Patch set$Xgafv(String $Xgafv)
```
    Description copied from class: DataprocRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DataprocRequest<Operation>
  - setAccessToken
```
public Dataproc.Projects.Regions.Clusters.Patch setAccessToken(String accessToken)
```
    Description copied from class: DataprocRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DataprocRequest<Operation>
  - setAlt
```
public Dataproc.Projects.Regions.Clusters.Patch setAlt(String alt)
```
    Description copied from class: DataprocRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DataprocRequest<Operation>
  - setCallback
```
public Dataproc.Projects.Regions.Clusters.Patch setCallback(String callback)
```
    Description copied from class: DataprocRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DataprocRequest<Operation>
  - setFields
```
public Dataproc.Projects.Regions.Clusters.Patch setFields(String fields)
```
    Description copied from class: DataprocRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DataprocRequest<Operation>
  - setKey
```
public Dataproc.Projects.Regions.Clusters.Patch setKey(String key)
```
    Description copied from class: DataprocRequest
    
    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.
    
    Overrides:
    
    setKey in class DataprocRequest<Operation>
  - setOauthToken
```
public Dataproc.Projects.Regions.Clusters.Patch setOauthToken(String oauthToken)
```
    Description copied from class: DataprocRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DataprocRequest<Operation>
  - setPrettyPrint
```
public Dataproc.Projects.Regions.Clusters.Patch setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DataprocRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DataprocRequest<Operation>
  - setQuotaUser
```
public Dataproc.Projects.Regions.Clusters.Patch setQuotaUser(String quotaUser)
```
    Description copied from class: DataprocRequest
    
    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.
    
    Overrides:
    
    setQuotaUser in class DataprocRequest<Operation>
  - setUploadType
```
public Dataproc.Projects.Regions.Clusters.Patch setUploadType(String uploadType)
```
    Description copied from class: DataprocRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DataprocRequest<Operation>
  - setUploadProtocol
```
public Dataproc.Projects.Regions.Clusters.Patch setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DataprocRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DataprocRequest<Operation>
  - getProjectId
```
public String getProjectId()
```
    Required. The ID of the Google Cloud Platform project the cluster belongs to.
  - setProjectId
```
public Dataproc.Projects.Regions.Clusters.Patch setProjectId(String projectId)
```
    Required. The ID of the Google Cloud Platform project the cluster belongs to.
  - getRegion
```
public String getRegion()
```
    Required. The Dataproc region in which to handle the request.
  - setRegion
```
public Dataproc.Projects.Regions.Clusters.Patch setRegion(String region)
```
    Required. The Dataproc region in which to handle the request.
  - getClusterName
```
public String getClusterName()
```
    Required. The cluster name.
  - setClusterName
```
public Dataproc.Projects.Regions.Clusters.Patch setClusterName(String clusterName)
```
    Required. The cluster name.
  - getGracefulDecommissionTimeout
```
public String getGracefulDecommissionTimeout()
```
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.
  - setGracefulDecommissionTimeout
```
public Dataproc.Projects.Regions.Clusters.Patch setGracefulDecommissionTimeout(String gracefulDecommissionTimeout)
```
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.
  - getRequestId
```
public String getRequestId()
```
    Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#google.cloud.da taproc.v1beta2.UpdateClusterRequest)s 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.
  - setRequestId
```
public Dataproc.Projects.Regions.Clusters.Patch setRequestId(String requestId)
```
    Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud .dataproc.v1beta2#google.cloud.dataproc.v1beta2.UpdateClusterRequest)s 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.
  - getUpdateMask
```
public String getUpdateMask()
```
    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
  - setUpdateMask
```
public Dataproc.Projects.Regions.Clusters.Patch setUpdateMask(String updateMask)
```
    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
  - set
```
public Dataproc.Projects.Regions.Clusters.Patch set(String parameterName,
                                                    Object value)
```
    Overrides:
    
    set in class DataprocRequest<Operation>

Class Dataproc.Projects.Regions.Clusters.Patch

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.dataproc.v1beta2.DataprocRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Patch

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getProjectId

setProjectId

getRegion

setRegion

getClusterName

setClusterName

getGracefulDecommissionTimeout

setGracefulDecommissionTimeout

getRequestId

setRequestId

getUpdateMask

setUpdateMask

set