Class UpdateClusterRequest.Builder (4.45.0) 

public static final class UpdateClusterRequest.Builder extends GeneratedMessageV3.Builder<UpdateClusterRequest.Builder> implements UpdateClusterRequestOrBuilder

A request to update a cluster.

Protobuf type google.cloud.dataproc.v1.UpdateClusterRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateClusterRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateClusterRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

build()

public UpdateClusterRequest build()
Returns
Type Description
UpdateClusterRequest

buildPartial()

public UpdateClusterRequest buildPartial()
Returns
Type Description
UpdateClusterRequest

clear()

public UpdateClusterRequest.Builder clear()
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

clearCluster()

public UpdateClusterRequest.Builder clearCluster()

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateClusterRequest.Builder

clearClusterName()

public UpdateClusterRequest.Builder clearClusterName()

Required. The cluster name.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UpdateClusterRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

clearGracefulDecommissionTimeout()

public UpdateClusterRequest.Builder clearGracefulDecommissionTimeout()

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateClusterRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateClusterRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

clearProjectId()

public UpdateClusterRequest.Builder clearProjectId()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

clearRegion()

public UpdateClusterRequest.Builder clearRegion()

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

string region = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

clearRequestId()

public UpdateClusterRequest.Builder clearRequestId()

Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequests 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.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

clearUpdateMask()

public UpdateClusterRequest.Builder clearUpdateMask()

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateClusterRequest.Builder

clone()

public UpdateClusterRequest.Builder clone()
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

getCluster()

public Cluster getCluster()

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Cluster

The cluster.

getClusterBuilder()

public Cluster.Builder getClusterBuilder()

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Cluster.Builder

getClusterName()

public String getClusterName()

Required. The cluster name.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Required. The cluster name.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for clusterName.

getClusterOrBuilder()

public ClusterOrBuilder getClusterOrBuilder()

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ClusterOrBuilder

getDefaultInstanceForType()

public UpdateClusterRequest getDefaultInstanceForType()
Returns
Type Description
UpdateClusterRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getGracefulDecommissionTimeout()

public Duration getGracefulDecommissionTimeout()

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The gracefulDecommissionTimeout.

getGracefulDecommissionTimeoutBuilder()

public Duration.Builder getGracefulDecommissionTimeoutBuilder()

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getGracefulDecommissionTimeoutOrBuilder()

public DurationOrBuilder getGracefulDecommissionTimeoutOrBuilder()

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getProjectId()

public String getProjectId()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getRegion()

public String getRegion()

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

string region = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

string region = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for region.

getRequestId()

public String getRequestId()

Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequests 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.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequests 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.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestId.

getUpdateMask()

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMaskOrBuilder

hasCluster()

public boolean hasCluster()

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the cluster field is set.

hasGracefulDecommissionTimeout()

public boolean hasGracefulDecommissionTimeout()

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the gracefulDecommissionTimeout field is set.

hasUpdateMask()

public boolean hasUpdateMask()

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCluster(Cluster value)

public UpdateClusterRequest.Builder mergeCluster(Cluster value)

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Cluster
Returns
Type Description
UpdateClusterRequest.Builder

mergeFrom(UpdateClusterRequest other)

public UpdateClusterRequest.Builder mergeFrom(UpdateClusterRequest other)
Parameter
Name Description
other UpdateClusterRequest
Returns
Type Description
UpdateClusterRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateClusterRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateClusterRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateClusterRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

mergeGracefulDecommissionTimeout(Duration value)

public UpdateClusterRequest.Builder mergeGracefulDecommissionTimeout(Duration value)

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
UpdateClusterRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateClusterRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateClusterRequest.Builder mergeUpdateMask(FieldMask value)

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateClusterRequest.Builder

setCluster(Cluster value)

public UpdateClusterRequest.Builder setCluster(Cluster value)

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Cluster
Returns
Type Description
UpdateClusterRequest.Builder

setCluster(Cluster.Builder builderForValue)

public UpdateClusterRequest.Builder setCluster(Cluster.Builder builderForValue)

Required. The changes to the cluster.

.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Cluster.Builder
Returns
Type Description
UpdateClusterRequest.Builder

setClusterName(String value)

public UpdateClusterRequest.Builder setClusterName(String value)

Required. The cluster name.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The clusterName to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setClusterNameBytes(ByteString value)

public UpdateClusterRequest.Builder setClusterNameBytes(ByteString value)

Required. The cluster name.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for clusterName to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateClusterRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

setGracefulDecommissionTimeout(Duration value)

public UpdateClusterRequest.Builder setGracefulDecommissionTimeout(Duration value)

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
UpdateClusterRequest.Builder

setGracefulDecommissionTimeout(Duration.Builder builderForValue)

public UpdateClusterRequest.Builder setGracefulDecommissionTimeout(Duration.Builder builderForValue)

Optional. Timeout for graceful YARN decommissioning. 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.

.google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateClusterRequest.Builder

setProjectId(String value)

public UpdateClusterRequest.Builder setProjectId(String value)

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The projectId to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public UpdateClusterRequest.Builder setProjectIdBytes(ByteString value)

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for projectId to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setRegion(String value)

public UpdateClusterRequest.Builder setRegion(String value)

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

string region = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The region to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public UpdateClusterRequest.Builder setRegionBytes(ByteString value)

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

string region = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateClusterRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

setRequestId(String value)

public UpdateClusterRequest.Builder setRequestId(String value)

Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequests 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.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The requestId to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public UpdateClusterRequest.Builder setRequestIdBytes(ByteString value)

Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequests 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.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for requestId to set.
Returns
Type Description
UpdateClusterRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateClusterRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateClusterRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateClusterRequest.Builder setUpdateMask(FieldMask value)

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateClusterRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateClusterRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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

<strong>Note:</strong> Currently, only the following fields can be updated:

<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateClusterRequest.Builder