Package com.google.dataflow.v1beta3

Class RuntimeUpdatableParams

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.RuntimeUpdatableParams
All Implemented Interfaces:
RuntimeUpdatableParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RuntimeUpdatableParams extends com.google.protobuf.GeneratedMessage implements RuntimeUpdatableParamsOrBuilder
 Additional job parameters that can only be updated during runtime using the
 projects.jobs.update method. These fields have no effect when specified
 during job creation.
Protobuf type google.dataflow.v1beta3.RuntimeUpdatableParams
See Also:

  • Field Details

    • MAX_NUM_WORKERS_FIELD_NUMBER

      public static final int MAX_NUM_WORKERS_FIELD_NUMBER
      See Also:

    • MIN_NUM_WORKERS_FIELD_NUMBER

      public static final int MIN_NUM_WORKERS_FIELD_NUMBER
      See Also:

    • WORKER_UTILIZATION_HINT_FIELD_NUMBER

      public static final int WORKER_UTILIZATION_HINT_FIELD_NUMBER
      See Also:

    • ACCEPTABLE_BACKLOG_DURATION_FIELD_NUMBER

      public static final int ACCEPTABLE_BACKLOG_DURATION_FIELD_NUMBER
      See Also:

    • AUTOSCALING_TIER_FIELD_NUMBER

      public static final int AUTOSCALING_TIER_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasMaxNumWorkers

      public boolean hasMaxNumWorkers()
       The maximum number of workers to cap autoscaling at. This field is
 currently only supported for Streaming Engine jobs.
      optional int32 max_num_workers = 1;
      Specified by:
      hasMaxNumWorkers in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      Whether the maxNumWorkers field is set.

    • getMaxNumWorkers

      public int getMaxNumWorkers()
       The maximum number of workers to cap autoscaling at. This field is
 currently only supported for Streaming Engine jobs.
      optional int32 max_num_workers = 1;
      Specified by:
      getMaxNumWorkers in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      The maxNumWorkers.

    • hasMinNumWorkers

      public boolean hasMinNumWorkers()
       The minimum number of workers to scale down to. This field is currently
 only supported for Streaming Engine jobs.
      optional int32 min_num_workers = 2;
      Specified by:
      hasMinNumWorkers in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      Whether the minNumWorkers field is set.

    • getMinNumWorkers

      public int getMinNumWorkers()
       The minimum number of workers to scale down to. This field is currently
 only supported for Streaming Engine jobs.
      optional int32 min_num_workers = 2;
      Specified by:
      getMinNumWorkers in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      The minNumWorkers.

    • hasWorkerUtilizationHint

      public boolean hasWorkerUtilizationHint()
       Target worker utilization, compared against the aggregate utilization of
 the worker pool by autoscaler, to determine upscaling and downscaling when
 absent other constraints such as backlog.
 For more information, see
 [Update an existing
 pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
      optional double worker_utilization_hint = 3;
      Specified by:
      hasWorkerUtilizationHint in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      Whether the workerUtilizationHint field is set.

    • getWorkerUtilizationHint

      public double getWorkerUtilizationHint()
       Target worker utilization, compared against the aggregate utilization of
 the worker pool by autoscaler, to determine upscaling and downscaling when
 absent other constraints such as backlog.
 For more information, see
 [Update an existing
 pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
      optional double worker_utilization_hint = 3;
      Specified by:
      getWorkerUtilizationHint in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      The workerUtilizationHint.

    • hasAcceptableBacklogDuration

      @Deprecated public boolean hasAcceptableBacklogDuration()
      Deprecated.
      google.dataflow.v1beta3.RuntimeUpdatableParams.acceptable_backlog_duration is deprecated. See google/dataflow/v1beta3/jobs.proto;l=352
       Optional. Deprecated: Use `autoscaling_tier` instead.
 The backlog threshold duration in seconds for autoscaling. Value must be
 non-negative.
      optional .google.protobuf.Duration acceptable_backlog_duration = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAcceptableBacklogDuration in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      Whether the acceptableBacklogDuration field is set.

    • getAcceptableBacklogDuration

      @Deprecated public com.google.protobuf.Duration getAcceptableBacklogDuration()
      Deprecated.
      google.dataflow.v1beta3.RuntimeUpdatableParams.acceptable_backlog_duration is deprecated. See google/dataflow/v1beta3/jobs.proto;l=352
       Optional. Deprecated: Use `autoscaling_tier` instead.
 The backlog threshold duration in seconds for autoscaling. Value must be
 non-negative.
      optional .google.protobuf.Duration acceptable_backlog_duration = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAcceptableBacklogDuration in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      The acceptableBacklogDuration.

    • getAcceptableBacklogDurationOrBuilder

      @Deprecated public com.google.protobuf.DurationOrBuilder getAcceptableBacklogDurationOrBuilder()
      Deprecated.
       Optional. Deprecated: Use `autoscaling_tier` instead.
 The backlog threshold duration in seconds for autoscaling. Value must be
 non-negative.
      optional .google.protobuf.Duration acceptable_backlog_duration = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAcceptableBacklogDurationOrBuilder in interface RuntimeUpdatableParamsOrBuilder

    • hasAutoscalingTier

      public boolean hasAutoscalingTier()
       Optional. The backlog threshold tier for autoscaling. Value must be one of
 "low-latency", "medium-latency", or "high-latency".
      optional string autoscaling_tier = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAutoscalingTier in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      Whether the autoscalingTier field is set.

    • getAutoscalingTier

      public String getAutoscalingTier()
       Optional. The backlog threshold tier for autoscaling. Value must be one of
 "low-latency", "medium-latency", or "high-latency".
      optional string autoscaling_tier = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoscalingTier in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      The autoscalingTier.

    • getAutoscalingTierBytes

      public com.google.protobuf.ByteString getAutoscalingTierBytes()
       Optional. The backlog threshold tier for autoscaling. Value must be one of
 "low-latency", "medium-latency", or "high-latency".
      optional string autoscaling_tier = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoscalingTierBytes in interface RuntimeUpdatableParamsOrBuilder
      Returns:
      The bytes for autoscalingTier.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 RuntimeUpdatableParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RuntimeUpdatableParams parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuntimeUpdatableParams parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RuntimeUpdatableParams parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RuntimeUpdatableParams parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuntimeUpdatableParams parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuntimeUpdatableParams parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static RuntimeUpdatableParams.Builder newBuilder()

    • newBuilder

      public static RuntimeUpdatableParams.Builder newBuilder(RuntimeUpdatableParams prototype)

    • toBuilder

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

    • newBuilderForType

      protected RuntimeUpdatableParams.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RuntimeUpdatableParams getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RuntimeUpdatableParams> parser()

    • getParserForType

      public com.google.protobuf.Parser<RuntimeUpdatableParams> 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.GeneratedMessage

    • getDefaultInstanceForType

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