Class BasicYarnAutoscalingConfig.Builder (4.0.5)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BasicYarnAutoscalingConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder
Overrides

build()

public BasicYarnAutoscalingConfig build()
Returns
TypeDescription
BasicYarnAutoscalingConfig

buildPartial()

public BasicYarnAutoscalingConfig buildPartial()
Returns
TypeDescription
BasicYarnAutoscalingConfig

clear()

public BasicYarnAutoscalingConfig.Builder clear()
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public BasicYarnAutoscalingConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
BasicYarnAutoscalingConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BasicYarnAutoscalingConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

clone()

public BasicYarnAutoscalingConfig.Builder clone()
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder
Overrides

getDefaultInstanceForType()

public BasicYarnAutoscalingConfig getDefaultInstanceForType()
Returns
TypeDescription
BasicYarnAutoscalingConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the gracefulDecommissionTimeout field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BasicYarnAutoscalingConfig other)

public BasicYarnAutoscalingConfig.Builder mergeFrom(BasicYarnAutoscalingConfig other)
Parameter
NameDescription
otherBasicYarnAutoscalingConfig
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BasicYarnAutoscalingConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BasicYarnAutoscalingConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BasicYarnAutoscalingConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public BasicYarnAutoscalingConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

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

public BasicYarnAutoscalingConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuedouble

The scaleDownFactor to set.

Returns
TypeDescription
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
NameDescription
valuedouble

The scaleDownMinWorkerFraction to set.

Returns
TypeDescription
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
NameDescription
valuedouble

The scaleUpFactor to set.

Returns
TypeDescription
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
NameDescription
valuedouble

The scaleUpMinWorkerFraction to set.

Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BasicYarnAutoscalingConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder
Overrides