Package com.google.cloud.dataproc.v1

Class BasicYarnAutoscalingConfig

  • All Implemented Interfaces:
    BasicYarnAutoscalingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BasicYarnAutoscalingConfig
extends com.google.protobuf.GeneratedMessageV3
implements BasicYarnAutoscalingConfigOrBuilder
     Basic autoscaling configurations for YARN.
    Protobuf type google.cloud.dataproc.v1.BasicYarnAutoscalingConfig
    See Also:
    Serialized Form

    • Field Detail

      • GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER

        public static final int GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCALE_UP_FACTOR_FIELD_NUMBER

        public static final int SCALE_UP_FACTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCALE_DOWN_FACTOR_FIELD_NUMBER

        public static final int SCALE_DOWN_FACTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCALE_UP_MIN_WORKER_FRACTION_FIELD_NUMBER

        public static final int SCALE_UP_MIN_WORKER_FRACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCALE_DOWN_MIN_WORKER_FRACTION_FIELD_NUMBER

        public static final int SCALE_DOWN_MIN_WORKER_FRACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        hasGracefulDecommissionTimeout in interface BasicYarnAutoscalingConfigOrBuilder
        Returns:
        Whether the gracefulDecommissionTimeout field is set.

      • getGracefulDecommissionTimeout

        public com.google.protobuf.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];
        Specified by:
        getGracefulDecommissionTimeout in interface BasicYarnAutoscalingConfigOrBuilder
        Returns:
        The gracefulDecommissionTimeout.

      • getGracefulDecommissionTimeoutOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getGracefulDecommissionTimeoutOrBuilder in interface BasicYarnAutoscalingConfigOrBuilder

      • 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](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
 for more information.

 Bounds: [0.0, 1.0].
        double scale_up_factor = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getScaleUpFactor in interface BasicYarnAutoscalingConfigOrBuilder
        Returns:
        The scaleUpFactor.

      • 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](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
 for more information.

 Bounds: [0.0, 1.0].
        double scale_down_factor = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getScaleDownFactor in interface BasicYarnAutoscalingConfigOrBuilder
        Returns:
        The scaleDownFactor.

      • 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];
        Specified by:
        getScaleUpMinWorkerFraction in interface BasicYarnAutoscalingConfigOrBuilder
        Returns:
        The scaleUpMinWorkerFraction.

      • 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];
        Specified by:
        getScaleDownMinWorkerFraction in interface BasicYarnAutoscalingConfigOrBuilder
        Returns:
        The scaleDownMinWorkerFraction.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static BasicYarnAutoscalingConfig parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BasicYarnAutoscalingConfig parseFrom​(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BasicYarnAutoscalingConfig parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BasicYarnAutoscalingConfig parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BasicYarnAutoscalingConfig parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BasicYarnAutoscalingConfig parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public BasicYarnAutoscalingConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public BasicYarnAutoscalingConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected BasicYarnAutoscalingConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<BasicYarnAutoscalingConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public BasicYarnAutoscalingConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder