Google Cloud Dataproc V1 Client - Class BasicYarnAutoscalingConfig (3.2.2)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class BasicYarnAutoscalingConfig.

Basic autoscaling configurations for YARN.

Generated from protobuf message google.cloud.dataproc.v1.BasicYarnAutoscalingConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ graceful_decommission_timeout Google\Protobuf\Duration

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].

↳ scale_up_factor float

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].

↳ scale_down_factor float

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].

↳ scale_up_min_worker_fraction float

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.

↳ scale_down_min_worker_fraction float

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.

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].

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

Returns
TypeDescription
Google\Protobuf\Duration|null

hasGracefulDecommissionTimeout

clearGracefulDecommissionTimeout

setGracefulDecommissionTimeout

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].

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

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

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].

Generated from protobuf field double scale_up_factor = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
float

setScaleUpFactor

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].

Generated from protobuf field double scale_up_factor = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var float
Returns
TypeDescription
$this

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].

Generated from protobuf field double scale_down_factor = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
float

setScaleDownFactor

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].

Generated from protobuf field double scale_down_factor = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var float
Returns
TypeDescription
$this

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.

Generated from protobuf field double scale_up_min_worker_fraction = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
float

setScaleUpMinWorkerFraction

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.

Generated from protobuf field double scale_up_min_worker_fraction = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var float
Returns
TypeDescription
$this

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.

Generated from protobuf field double scale_down_min_worker_fraction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
float

setScaleDownMinWorkerFraction

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.

Generated from protobuf field double scale_down_min_worker_fraction = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var float
Returns
TypeDescription
$this