Class BasicYarnAutoscalingConfig.Builder (4.48.0)

public static final class BasicYarnAutoscalingConfig.Builder extends GeneratedMessageV3.Builder<BasicYarnAutoscalingConfig.Builder> implements BasicYarnAutoscalingConfigOrBuilder

Basic autoscaling configurations for YARN.

Protobuf type google.cloud.dataproc.v1.BasicYarnAutoscalingConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BasicYarnAutoscalingConfig build()
Returns
Type Description
BasicYarnAutoscalingConfig

buildPartial()

public BasicYarnAutoscalingConfig buildPartial()
Returns
Type Description
BasicYarnAutoscalingConfig

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearGracefulDecommissionTimeout()

public BasicYarnAutoscalingConfig.Builder clearGracefulDecommissionTimeout()

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearScaleDownFactor()

public BasicYarnAutoscalingConfig.Builder clearScaleDownFactor()

Required. Fraction of average YARN pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job. See How autoscaling works for more information.

Bounds: [0.0, 1.0].

double scale_down_factor = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

clearScaleDownMinWorkerFraction()

public BasicYarnAutoscalingConfig.Builder clearScaleDownMinWorkerFraction()

Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.

Bounds: [0.0, 1.0]. Default: 0.0.

double scale_down_min_worker_fraction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

clearScaleUpFactor()

public BasicYarnAutoscalingConfig.Builder clearScaleUpFactor()

Required. Fraction of average YARN pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling). See How autoscaling works for more information.

Bounds: [0.0, 1.0].

double scale_up_factor = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

clearScaleUpMinWorkerFraction()

public BasicYarnAutoscalingConfig.Builder clearScaleUpMinWorkerFraction()

Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.

Bounds: [0.0, 1.0]. Default: 0.0.

double scale_up_min_worker_fraction = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public BasicYarnAutoscalingConfig getDefaultInstanceForType()
Returns
Type Description
BasicYarnAutoscalingConfig

getDescriptorForType()

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

getGracefulDecommissionTimeout()

public Duration getGracefulDecommissionTimeout()

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The gracefulDecommissionTimeout.

getGracefulDecommissionTimeoutBuilder()

public Duration.Builder getGracefulDecommissionTimeoutBuilder()

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getGracefulDecommissionTimeoutOrBuilder()

public DurationOrBuilder getGracefulDecommissionTimeoutOrBuilder()

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getScaleDownFactor()

public double getScaleDownFactor()

Required. Fraction of average YARN pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job. See How autoscaling works for more information.

Bounds: [0.0, 1.0].

double scale_down_factor = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
double

The scaleDownFactor.

getScaleDownMinWorkerFraction()

public double getScaleDownMinWorkerFraction()

Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.

Bounds: [0.0, 1.0]. Default: 0.0.

double scale_down_min_worker_fraction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The scaleDownMinWorkerFraction.

getScaleUpFactor()

public double getScaleUpFactor()

Required. Fraction of average YARN pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling). See How autoscaling works for more information.

Bounds: [0.0, 1.0].

double scale_up_factor = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
double

The scaleUpFactor.

getScaleUpMinWorkerFraction()

public double getScaleUpMinWorkerFraction()

Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.

Bounds: [0.0, 1.0]. Default: 0.0.

double scale_up_min_worker_fraction = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The scaleUpMinWorkerFraction.

hasGracefulDecommissionTimeout()

public boolean hasGracefulDecommissionTimeout()

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the gracefulDecommissionTimeout field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BasicYarnAutoscalingConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGracefulDecommissionTimeout(Duration value)

public BasicYarnAutoscalingConfig.Builder mergeGracefulDecommissionTimeout(Duration value)

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
BasicYarnAutoscalingConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setGracefulDecommissionTimeout(Duration value)

public BasicYarnAutoscalingConfig.Builder setGracefulDecommissionTimeout(Duration value)

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
BasicYarnAutoscalingConfig.Builder

setGracefulDecommissionTimeout(Duration.Builder builderForValue)

public BasicYarnAutoscalingConfig.Builder setGracefulDecommissionTimeout(Duration.Builder builderForValue)

Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.

Bounds: [0s, 1d].

.google.protobuf.Duration graceful_decommission_timeout = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BasicYarnAutoscalingConfig.Builder

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

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

setScaleDownFactor(double value)

public BasicYarnAutoscalingConfig.Builder setScaleDownFactor(double value)

Required. Fraction of average YARN pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job. See How autoscaling works for more information.

Bounds: [0.0, 1.0].

double scale_down_factor = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value double

The scaleDownFactor to set.

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

setScaleDownMinWorkerFraction(double value)

public BasicYarnAutoscalingConfig.Builder setScaleDownMinWorkerFraction(double value)

Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.

Bounds: [0.0, 1.0]. Default: 0.0.

double scale_down_min_worker_fraction = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The scaleDownMinWorkerFraction to set.

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

setScaleUpFactor(double value)

public BasicYarnAutoscalingConfig.Builder setScaleUpFactor(double value)

Required. Fraction of average YARN pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling). See How autoscaling works for more information.

Bounds: [0.0, 1.0].

double scale_up_factor = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value double

The scaleUpFactor to set.

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

setScaleUpMinWorkerFraction(double value)

public BasicYarnAutoscalingConfig.Builder setScaleUpMinWorkerFraction(double value)

Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.

Bounds: [0.0, 1.0]. Default: 0.0.

double scale_up_min_worker_fraction = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The scaleUpMinWorkerFraction to set.

Returns
Type Description
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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