Class RuntimeUpdatableParams (0.95.0)

0.95.0 (latest) 0.92.0 0.91.0 0.89.0 0.87.0 0.86.0 0.85.0 0.84.0 0.82.0 0.80.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.68.0 0.67.0 0.66.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.5.0

public final class RuntimeUpdatableParams extends 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > RuntimeUpdatableParams

Implements

RuntimeUpdatableParamsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ACCEPTABLE_BACKLOG_DURATION_FIELD_NUMBER

public static final int ACCEPTABLE_BACKLOG_DURATION_FIELD_NUMBER

Field Value
Type	Description
int

AUTOSCALING_TIER_FIELD_NUMBER

public static final int AUTOSCALING_TIER_FIELD_NUMBER

Field Value
Type	Description
int

MAX_NUM_WORKERS_FIELD_NUMBER

public static final int MAX_NUM_WORKERS_FIELD_NUMBER

Field Value
Type	Description
int

MIN_NUM_WORKERS_FIELD_NUMBER

public static final int MIN_NUM_WORKERS_FIELD_NUMBER

Field Value
Type	Description
int

WORKER_UTILIZATION_HINT_FIELD_NUMBER

public static final int WORKER_UTILIZATION_HINT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static RuntimeUpdatableParams getDefaultInstance()

Returns
Type	Description
RuntimeUpdatableParams

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static RuntimeUpdatableParams.Builder newBuilder()

Returns
Type	Description
RuntimeUpdatableParams.Builder

newBuilder(RuntimeUpdatableParams prototype)

public static RuntimeUpdatableParams.Builder newBuilder(RuntimeUpdatableParams prototype)

Parameter
Name	Description
prototype	RuntimeUpdatableParams

Returns
Type	Description
RuntimeUpdatableParams.Builder

parseDelimitedFrom(InputStream input)

public static RuntimeUpdatableParams parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeUpdatableParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static RuntimeUpdatableParams parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RuntimeUpdatableParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RuntimeUpdatableParams parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RuntimeUpdatableParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RuntimeUpdatableParams parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeUpdatableParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static RuntimeUpdatableParams parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RuntimeUpdatableParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static RuntimeUpdatableParams parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RuntimeUpdatableParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RuntimeUpdatableParams

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<RuntimeUpdatableParams> parser()

Returns
Type	Description
Parser<RuntimeUpdatableParams>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAcceptableBacklogDuration() (deprecated)

public 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];

Returns
Type	Description
Duration	The acceptableBacklogDuration.

getAcceptableBacklogDurationOrBuilder() (deprecated)

public DurationOrBuilder getAcceptableBacklogDurationOrBuilder()

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];

Returns
Type	Description
DurationOrBuilder

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];

Returns
Type	Description
String	The autoscalingTier.

getAutoscalingTierBytes()

public 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];

Returns
Type	Description
ByteString	The bytes for autoscalingTier.

getDefaultInstanceForType()

public RuntimeUpdatableParams getDefaultInstanceForType()

Returns
Type	Description
RuntimeUpdatableParams

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;

Returns
Type	Description
int	The maxNumWorkers.

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;

Returns
Type	Description
int	The minNumWorkers.

getParserForType()

public Parser<RuntimeUpdatableParams> getParserForType()

Returns
Type	Description
Parser<RuntimeUpdatableParams>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

optional double worker_utilization_hint = 3;

Returns
Type	Description
double	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];

Returns
Type	Description
boolean	Whether the acceptableBacklogDuration field is set.

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];

Returns
Type	Description
boolean	Whether the autoscalingTier field is set.

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;

Returns
Type	Description
boolean	Whether the maxNumWorkers field is set.

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;

Returns
Type	Description
boolean	Whether the minNumWorkers field is set.

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.

optional double worker_utilization_hint = 3;

Returns
Type	Description
boolean	Whether the workerUtilizationHint field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public RuntimeUpdatableParams.Builder newBuilderForType()

Returns
Type	Description
RuntimeUpdatableParams.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RuntimeUpdatableParams.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
RuntimeUpdatableParams.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public RuntimeUpdatableParams.Builder toBuilder()

Returns
Type	Description
RuntimeUpdatableParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException