Class RuntimeUpdatableParams.Builder (0.95.0)

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

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

clearAcceptableBacklogDuration() (deprecated)

public RuntimeUpdatableParams.Builder clearAcceptableBacklogDuration()

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

clearAutoscalingTier()

public RuntimeUpdatableParams.Builder clearAutoscalingTier()

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

This builder for chaining.

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.

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.

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.

getAcceptableBacklogDurationBuilder() (deprecated)

public Duration.Builder getAcceptableBacklogDurationBuilder()

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
Builder

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAcceptableBacklogDuration(Duration value) (deprecated)

public RuntimeUpdatableParams.Builder mergeAcceptableBacklogDuration(Duration value)

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

Parameter
Name Description
value Duration
Returns
Type Description
RuntimeUpdatableParams.Builder

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

setAcceptableBacklogDuration(Duration value) (deprecated)

public RuntimeUpdatableParams.Builder setAcceptableBacklogDuration(Duration value)

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

Parameter
Name Description
value Duration
Returns
Type Description
RuntimeUpdatableParams.Builder

setAcceptableBacklogDuration(Duration.Builder builderForValue) (deprecated)

public RuntimeUpdatableParams.Builder setAcceptableBacklogDuration(Duration.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RuntimeUpdatableParams.Builder

setAutoscalingTier(String value)

public RuntimeUpdatableParams.Builder setAutoscalingTier(String value)

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

Parameter
Name Description
value String

The autoscalingTier to set.

Returns
Type Description
RuntimeUpdatableParams.Builder

This builder for chaining.

setAutoscalingTierBytes(ByteString value)

public RuntimeUpdatableParams.Builder setAutoscalingTierBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for autoscalingTier to set.

Returns
Type Description
RuntimeUpdatableParams.Builder

This builder for chaining.

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.

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.