Class InstanceGroupAutoscalingPolicyConfig.Builder (4.27.0)

public static final class InstanceGroupAutoscalingPolicyConfig.Builder extends GeneratedMessageV3.Builder<InstanceGroupAutoscalingPolicyConfig.Builder> implements InstanceGroupAutoscalingPolicyConfigOrBuilder

Configuration for the size bounds of an instance group, including its proportional size to other groups.

Protobuf type google.cloud.dataproc.v1.InstanceGroupAutoscalingPolicyConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public InstanceGroupAutoscalingPolicyConfig build()
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig

buildPartial()

public InstanceGroupAutoscalingPolicyConfig buildPartial()
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig

clear()

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

clearField(Descriptors.FieldDescriptor field)

public InstanceGroupAutoscalingPolicyConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder
Overrides

clearMaxInstances()

public InstanceGroupAutoscalingPolicyConfig.Builder clearMaxInstances()

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.

int32 max_instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder

This builder for chaining.

clearMinInstances()

public InstanceGroupAutoscalingPolicyConfig.Builder clearMinInstances()

Optional. Minimum number of instances for this group.

Primary workers - Bounds: [2, max_instances]. Default: 2. Secondary workers - Bounds: [0, max_instances]. Default: 0.

int32 min_instances = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InstanceGroupAutoscalingPolicyConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder
Overrides

clearWeight()

public InstanceGroupAutoscalingPolicyConfig.Builder clearWeight()

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.

int32 weight = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public InstanceGroupAutoscalingPolicyConfig getDefaultInstanceForType()
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMaxInstances()

public int getMaxInstances()

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.

int32 max_instances = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The maxInstances.

getMinInstances()

public int getMinInstances()

Optional. Minimum number of instances for this group.

Primary workers - Bounds: [2, max_instances]. Default: 2. Secondary workers - Bounds: [0, max_instances]. Default: 0.

int32 min_instances = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The minInstances.

getWeight()

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

int32 weight = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The weight.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(InstanceGroupAutoscalingPolicyConfig other)

public InstanceGroupAutoscalingPolicyConfig.Builder mergeFrom(InstanceGroupAutoscalingPolicyConfig other)
Parameter
NameDescription
otherInstanceGroupAutoscalingPolicyConfig
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public InstanceGroupAutoscalingPolicyConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setMaxInstances(int value)

public InstanceGroupAutoscalingPolicyConfig.Builder setMaxInstances(int value)

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.

int32 max_instances = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueint

The maxInstances to set.

Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder

This builder for chaining.

setMinInstances(int value)

public InstanceGroupAutoscalingPolicyConfig.Builder setMinInstances(int value)

Optional. Minimum number of instances for this group.

Primary workers - Bounds: [2, max_instances]. Default: 2. Secondary workers - Bounds: [0, max_instances]. Default: 0.

int32 min_instances = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The minInstances to set.

Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder

This builder for chaining.

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

public InstanceGroupAutoscalingPolicyConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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

setWeight(int value)

public InstanceGroupAutoscalingPolicyConfig.Builder setWeight(int value)

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.

int32 weight = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The weight to set.

Returns
TypeDescription
InstanceGroupAutoscalingPolicyConfig.Builder

This builder for chaining.