Interface BasicYarnAutoscalingConfigOrBuilder (4.33.0)

public interface BasicYarnAutoscalingConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGracefulDecommissionTimeout()

public abstract 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.

getGracefulDecommissionTimeoutOrBuilder()

public abstract DurationOrBuilder getGracefulDecommissionTimeoutOrBuilder()

Bounds: [0s, 1d].

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

Returns
Type	Description
`DurationOrBuilder`

getScaleDownFactor()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasGracefulDecommissionTimeout()

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.