Class RuntimeUpdatableParams.Builder (0.67.0)

public static final class RuntimeUpdatableParams.Builder extends GeneratedMessageV3.Builder<RuntimeUpdatableParams.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RuntimeUpdatableParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

build()

public RuntimeUpdatableParams build()
Returns
Type Description
RuntimeUpdatableParams

buildPartial()

public RuntimeUpdatableParams buildPartial()
Returns
Type Description
RuntimeUpdatableParams

clear()

public RuntimeUpdatableParams.Builder clear()
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RuntimeUpdatableParams.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

clearMaxNumWorkers()

public RuntimeUpdatableParams.Builder clearMaxNumWorkers()

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
RuntimeUpdatableParams.Builder

This builder for chaining.

clearMinNumWorkers()

public RuntimeUpdatableParams.Builder clearMinNumWorkers()

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
RuntimeUpdatableParams.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RuntimeUpdatableParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

clearWorkerUtilizationHint()

public RuntimeUpdatableParams.Builder clearWorkerUtilizationHint()

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
RuntimeUpdatableParams.Builder

This builder for chaining.

clone()

public RuntimeUpdatableParams.Builder clone()
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

getDefaultInstanceForType()

public RuntimeUpdatableParams getDefaultInstanceForType()
Returns
Type Description
RuntimeUpdatableParams

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RuntimeUpdatableParams other)

public RuntimeUpdatableParams.Builder mergeFrom(RuntimeUpdatableParams other)
Parameter
Name Description
other RuntimeUpdatableParams
Returns
Type Description
RuntimeUpdatableParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RuntimeUpdatableParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RuntimeUpdatableParams.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeUpdatableParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RuntimeUpdatableParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

setMaxNumWorkers(int value)

public RuntimeUpdatableParams.Builder setMaxNumWorkers(int value)

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;

Parameter
Name Description
value int

The maxNumWorkers to set.

Returns
Type Description
RuntimeUpdatableParams.Builder

This builder for chaining.

setMinNumWorkers(int value)

public RuntimeUpdatableParams.Builder setMinNumWorkers(int value)

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;

Parameter
Name Description
value int

The minNumWorkers to set.

Returns
Type Description
RuntimeUpdatableParams.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RuntimeUpdatableParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeUpdatableParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RuntimeUpdatableParams.Builder
Overrides

setWorkerUtilizationHint(double value)

public RuntimeUpdatableParams.Builder setWorkerUtilizationHint(double value)

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;

Parameter
Name Description
value double

The workerUtilizationHint to set.

Returns
Type Description
RuntimeUpdatableParams.Builder

This builder for chaining.