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). SeeHow autoscaling worksfor 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. SeeHow autoscaling worksfor 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].
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].
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). SeeHow
autoscaling
worksfor more information.
Bounds: [0.0, 1.0].
Returns
Type
Description
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). SeeHow
autoscaling
worksfor more information.
Bounds: [0.0, 1.0].
Parameter
Name
Description
var
float
Returns
Type
Description
$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.
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.
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.
Returns
Type
Description
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.
Parameter
Name
Description
var
float
Returns
Type
Description
$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.
Returns
Type
Description
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc V1 Client - Class BasicYarnAutoscalingConfig (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.BasicYarnAutoscalingConfig)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.BasicYarnAutoscalingConfig)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.BasicYarnAutoscalingConfig)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.BasicYarnAutoscalingConfig)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.BasicYarnAutoscalingConfig)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.BasicYarnAutoscalingConfig)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.BasicYarnAutoscalingConfig)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.BasicYarnAutoscalingConfig)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.BasicYarnAutoscalingConfig)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.BasicYarnAutoscalingConfig)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.BasicYarnAutoscalingConfig)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.BasicYarnAutoscalingConfig)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.BasicYarnAutoscalingConfig)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.BasicYarnAutoscalingConfig)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.BasicYarnAutoscalingConfig)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.BasicYarnAutoscalingConfig)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.BasicYarnAutoscalingConfig)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.BasicYarnAutoscalingConfig)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.BasicYarnAutoscalingConfig) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class BasicYarnAutoscalingConfig.\n\nBasic autoscaling configurations for YARN.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.BasicYarnAutoscalingConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getGracefulDecommissionTimeout\n\nRequired. Timeout for YARN graceful decommissioning of Node Managers.\n\nSpecifies the duration to wait for jobs to complete before forcefully\nremoving workers (and potentially interrupting jobs). Only applicable to\ndownscaling operations.\nBounds: \\[0s, 1d\\].\n\n### hasGracefulDecommissionTimeout\n\n### clearGracefulDecommissionTimeout\n\n### setGracefulDecommissionTimeout\n\nRequired. Timeout for YARN graceful decommissioning of Node Managers.\n\nSpecifies the duration to wait for jobs to complete before forcefully\nremoving workers (and potentially interrupting jobs). Only applicable to\ndownscaling operations.\nBounds: \\[0s, 1d\\].\n\n### getScaleUpFactor\n\nRequired. Fraction of average YARN pending memory in the last cooldown\nperiod for which to add workers. A scale-up factor of 1.0 will result in\nscaling up so that there is no pending memory remaining after the update\n(more aggressive scaling). A scale-up factor closer to 0 will result in a\nsmaller magnitude of scaling up (less aggressive scaling). See [How\nautoscaling\nworks](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)\nfor more information.\n\nBounds: \\[0.0, 1.0\\].\n\n### setScaleUpFactor\n\nRequired. Fraction of average YARN pending memory in the last cooldown\nperiod for which to add workers. A scale-up factor of 1.0 will result in\nscaling up so that there is no pending memory remaining after the update\n(more aggressive scaling). A scale-up factor closer to 0 will result in a\nsmaller magnitude of scaling up (less aggressive scaling). See [How\nautoscaling\nworks](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)\nfor more information.\n\nBounds: \\[0.0, 1.0\\].\n\n### getScaleDownFactor\n\nRequired. Fraction of average YARN pending memory in the last cooldown\nperiod for which to remove workers. A scale-down factor of 1 will result in\nscaling down so that there is no available memory remaining after the\nupdate (more aggressive scaling). A scale-down factor of 0 disables\nremoving workers, which can be beneficial for autoscaling a single job.\n\nSee [How autoscaling\nworks](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)\nfor more information.\nBounds: \\[0.0, 1.0\\].\n\n### setScaleDownFactor\n\nRequired. Fraction of average YARN pending memory in the last cooldown\nperiod for which to remove workers. A scale-down factor of 1 will result in\nscaling down so that there is no available memory remaining after the\nupdate (more aggressive scaling). A scale-down factor of 0 disables\nremoving workers, which can be beneficial for autoscaling a single job.\n\nSee [How autoscaling\nworks](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)\nfor more information.\nBounds: \\[0.0, 1.0\\].\n\n### getScaleUpMinWorkerFraction\n\nOptional. Minimum scale-up threshold as a fraction of total cluster size\nbefore scaling occurs. For example, in a 20-worker cluster, a threshold of\n0.1 means the autoscaler must recommend at least a 2-worker scale-up for\nthe cluster to scale. A threshold of 0 means the autoscaler will scale up\non any recommended change.\n\nBounds: \\[0.0, 1.0\\]. Default: 0.0.\n\n### setScaleUpMinWorkerFraction\n\nOptional. Minimum scale-up threshold as a fraction of total cluster size\nbefore scaling occurs. For example, in a 20-worker cluster, a threshold of\n0.1 means the autoscaler must recommend at least a 2-worker scale-up for\nthe cluster to scale. A threshold of 0 means the autoscaler will scale up\non any recommended change.\n\nBounds: \\[0.0, 1.0\\]. Default: 0.0.\n\n### getScaleDownMinWorkerFraction\n\nOptional. Minimum scale-down threshold as a fraction of total cluster size\nbefore scaling occurs. For example, in a 20-worker cluster, a threshold of\n0.1 means the autoscaler must recommend at least a 2 worker scale-down for\nthe cluster to scale. A threshold of 0 means the autoscaler will scale down\non any recommended change.\n\nBounds: \\[0.0, 1.0\\]. Default: 0.0.\n\n### setScaleDownMinWorkerFraction\n\nOptional. Minimum scale-down threshold as a fraction of total cluster size\nbefore scaling occurs. For example, in a 20-worker cluster, a threshold of\n0.1 means the autoscaler must recommend at least a 2 worker scale-down for\nthe cluster to scale. A threshold of 0 means the autoscaler will scale down\non any recommended change.\n\nBounds: \\[0.0, 1.0\\]. Default: 0.0."]]