Reference documentation and code samples for the Google Cloud Dataproc V1 Client class InstanceGroupAutoscalingPolicyConfig.
Configuration for the size bounds of an instance group, including its
proportional size to other groups.
Generated from protobuf message google.cloud.dataproc.v1.InstanceGroupAutoscalingPolicyConfig
Namespace
Google \ Cloud \ Dataproc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ min_instances
int
Optional. Minimum number of instances for this group. Primary workers - Bounds: [2, max_instances]. Default: 2. Secondary workers - Bounds: [0, max_instances]. Default: 0.
↳ max_instances
int
Required. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set. Primary workers - Bounds: [min_instances, ). Secondary workers - Bounds: [min_instances, ). Default: 0.
↳ weight
int
Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker. The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created. If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
getMinInstances
Optional. Minimum number of instances for this group.
Required. Maximum number of instances for this group. Required for primary
workers. Note that by default, clusters will not use secondary workers.
Required for secondary workers if the minimum secondary instances is set.
Primary workers - Bounds: [min_instances, ).
Secondary workers - Bounds: [min_instances, ). Default: 0.
Returns
Type
Description
int
setMaxInstances
Required. Maximum number of instances for this group. Required for primary
workers. Note that by default, clusters will not use secondary workers.
Required for secondary workers if the minimum secondary instances is set.
Primary workers - Bounds: [min_instances, ).
Secondary workers - Bounds: [min_instances, ). Default: 0.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getWeight
Optional. Weight for the instance group, which is used to determine the
fraction of total workers in the cluster from this instance group.
For example, if primary workers have weight 2, and secondary workers have
weight 1, the cluster will have approximately 2 primary workers for each
secondary worker.
The cluster may not reach the specified balance if constrained
by min/max bounds or other autoscaling settings. For example, if
max_instances for secondary workers is 0, then only primary workers will
be added. The cluster can also be out of balance when created.
If weight is not set on any instance group, the cluster will default to
equal weight for all groups: the cluster will attempt to maintain an equal
number of workers in each group within the configured size bounds for each
group. If weight is set for one group only, the cluster will default to
zero weight on the unset group. For example if weight is set only on
primary workers, the cluster will use primary workers only and no
secondary workers.
Returns
Type
Description
int
setWeight
Optional. Weight for the instance group, which is used to determine the
fraction of total workers in the cluster from this instance group.
For example, if primary workers have weight 2, and secondary workers have
weight 1, the cluster will have approximately 2 primary workers for each
secondary worker.
The cluster may not reach the specified balance if constrained
by min/max bounds or other autoscaling settings. For example, if
max_instances for secondary workers is 0, then only primary workers will
be added. The cluster can also be out of balance when created.
If weight is not set on any instance group, the cluster will default to
equal weight for all groups: the cluster will attempt to maintain an equal
number of workers in each group within the configured size bounds for each
group. If weight is set for one group only, the cluster will default to
zero weight on the unset group. For example if weight is set only on
primary workers, the cluster will use primary workers only and no
secondary workers.
[[["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 InstanceGroupAutoscalingPolicyConfig (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.InstanceGroupAutoscalingPolicyConfig)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.InstanceGroupAutoscalingPolicyConfig)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.InstanceGroupAutoscalingPolicyConfig)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.InstanceGroupAutoscalingPolicyConfig)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.InstanceGroupAutoscalingPolicyConfig) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class InstanceGroupAutoscalingPolicyConfig.\n\nConfiguration for the size bounds of an instance group, including its\nproportional size to other groups.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.InstanceGroupAutoscalingPolicyConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMinInstances\n\nOptional. Minimum number of instances for this group.\n\nPrimary workers - Bounds: \\[2, max_instances\\]. Default: 2.\nSecondary workers - Bounds: \\[0, max_instances\\]. Default: 0.\n\n### setMinInstances\n\nOptional. Minimum number of instances for this group.\n\nPrimary workers - Bounds: \\[2, max_instances\\]. Default: 2.\nSecondary workers - Bounds: \\[0, max_instances\\]. Default: 0.\n\n### getMaxInstances\n\nRequired. Maximum number of instances for this group. Required for primary\nworkers. Note that by default, clusters will not use secondary workers.\n\nRequired for secondary workers if the minimum secondary instances is set.\nPrimary workers - Bounds: \\[min_instances, ).\nSecondary workers - Bounds: \\[min_instances, ). Default: 0.\n\n### setMaxInstances\n\nRequired. Maximum number of instances for this group. Required for primary\nworkers. Note that by default, clusters will not use secondary workers.\n\nRequired for secondary workers if the minimum secondary instances is set.\nPrimary workers - Bounds: \\[min_instances, ).\nSecondary workers - Bounds: \\[min_instances, ). Default: 0.\n\n### getWeight\n\nOptional. Weight for the instance group, which is used to determine the\nfraction of total workers in the cluster from this instance group.\n\nFor example, if primary workers have weight 2, and secondary workers have\nweight 1, the cluster will have approximately 2 primary workers for each\nsecondary worker.\nThe cluster may not reach the specified balance if constrained\nby min/max bounds or other autoscaling settings. For example, if\n`max_instances` for secondary workers is 0, then only primary workers will\nbe added. The cluster can also be out of balance when created.\nIf weight is not set on any instance group, the cluster will default to\nequal weight for all groups: the cluster will attempt to maintain an equal\nnumber of workers in each group within the configured size bounds for each\ngroup. If weight is set for one group only, the cluster will default to\nzero weight on the unset group. For example if weight is set only on\nprimary workers, the cluster will use primary workers only and no\nsecondary workers.\n\n### setWeight\n\nOptional. Weight for the instance group, which is used to determine the\nfraction of total workers in the cluster from this instance group.\n\nFor example, if primary workers have weight 2, and secondary workers have\nweight 1, the cluster will have approximately 2 primary workers for each\nsecondary worker.\nThe cluster may not reach the specified balance if constrained\nby min/max bounds or other autoscaling settings. For example, if\n`max_instances` for secondary workers is 0, then only primary workers will\nbe added. The cluster can also be out of balance when created.\nIf weight is not set on any instance group, the cluster will default to\nequal weight for all groups: the cluster will attempt to maintain an equal\nnumber of workers in each group within the configured size bounds for each\ngroup. If weight is set for one group only, the cluster will default to\nzero weight on the unset group. For example if weight is set only on\nprimary workers, the cluster will use primary workers only and no\nsecondary workers."]]