Class RuntimeUpdatableParams (0.67.0)

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

Static Fields

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RuntimeUpdatableParams.Builder newBuilderForType()
Returns
Type Description
RuntimeUpdatableParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RuntimeUpdatableParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RuntimeUpdatableParams.Builder toBuilder()
Returns
Type Description
RuntimeUpdatableParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException