Class BasicYarnAutoscalingConfig (4.18.0)

public final class BasicYarnAutoscalingConfig extends GeneratedMessageV3 implements BasicYarnAutoscalingConfigOrBuilder

Basic autoscaling configurations for YARN.

Protobuf type google.cloud.dataproc.v1.BasicYarnAutoscalingConfig

Static Fields

GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER

public static final int GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

SCALE_DOWN_FACTOR_FIELD_NUMBER

public static final int SCALE_DOWN_FACTOR_FIELD_NUMBER
Field Value
TypeDescription
int

SCALE_DOWN_MIN_WORKER_FRACTION_FIELD_NUMBER

public static final int SCALE_DOWN_MIN_WORKER_FRACTION_FIELD_NUMBER
Field Value
TypeDescription
int

SCALE_UP_FACTOR_FIELD_NUMBER

public static final int SCALE_UP_FACTOR_FIELD_NUMBER
Field Value
TypeDescription
int

SCALE_UP_MIN_WORKER_FRACTION_FIELD_NUMBER

public static final int SCALE_UP_MIN_WORKER_FRACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BasicYarnAutoscalingConfig getDefaultInstance()
Returns
TypeDescription
BasicYarnAutoscalingConfig

getDescriptor()

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

newBuilder()

public static BasicYarnAutoscalingConfig.Builder newBuilder()
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

newBuilder(BasicYarnAutoscalingConfig prototype)

public static BasicYarnAutoscalingConfig.Builder newBuilder(BasicYarnAutoscalingConfig prototype)
Parameter
NameDescription
prototypeBasicYarnAutoscalingConfig
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

parseDelimitedFrom(InputStream input)

public static BasicYarnAutoscalingConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicYarnAutoscalingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BasicYarnAutoscalingConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BasicYarnAutoscalingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BasicYarnAutoscalingConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BasicYarnAutoscalingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BasicYarnAutoscalingConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicYarnAutoscalingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BasicYarnAutoscalingConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicYarnAutoscalingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BasicYarnAutoscalingConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BasicYarnAutoscalingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicYarnAutoscalingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BasicYarnAutoscalingConfig> parser()
Returns
TypeDescription
Parser<BasicYarnAutoscalingConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BasicYarnAutoscalingConfig getDefaultInstanceForType()
Returns
TypeDescription
BasicYarnAutoscalingConfig

getGracefulDecommissionTimeout()

public 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
TypeDescription
Duration

The gracefulDecommissionTimeout.

getGracefulDecommissionTimeoutOrBuilder()

public DurationOrBuilder getGracefulDecommissionTimeoutOrBuilder()

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
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<BasicYarnAutoscalingConfig> getParserForType()
Returns
TypeDescription
Parser<BasicYarnAutoscalingConfig>
Overrides

getScaleDownFactor()

public 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
TypeDescription
double

The scaleDownFactor.

getScaleDownMinWorkerFraction()

public 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
TypeDescription
double

The scaleDownMinWorkerFraction.

getScaleUpFactor()

public 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
TypeDescription
double

The scaleUpFactor.

getScaleUpMinWorkerFraction()

public 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
TypeDescription
double

The scaleUpMinWorkerFraction.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasGracefulDecommissionTimeout()

public boolean hasGracefulDecommissionTimeout()

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
TypeDescription
boolean

Whether the gracefulDecommissionTimeout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BasicYarnAutoscalingConfig.Builder newBuilderForType()
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BasicYarnAutoscalingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BasicYarnAutoscalingConfig.Builder toBuilder()
Returns
TypeDescription
BasicYarnAutoscalingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException