com.google.api.services.dataflow.model

Class RuntimeUpdatableParams

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataflow.model.RuntimeUpdatableParams

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RuntimeUpdatableParams
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Dataflow API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RuntimeUpdatableParams()

Method Summary

Modifier and Type	Method and Description
RuntimeUpdatableParams	clone()
Integer	getMaxNumWorkers() The maximum number of workers to cap autoscaling at.
Integer	getMinNumWorkers() The minimum number of workers to scale down to.
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.
RuntimeUpdatableParams	set(String fieldName, Object value)
RuntimeUpdatableParams	setMaxNumWorkers(Integer maxNumWorkers) The maximum number of workers to cap autoscaling at.
RuntimeUpdatableParams	setMinNumWorkers(Integer minNumWorkers) The minimum number of workers to scale down to.
RuntimeUpdatableParams	setWorkerUtilizationHint(Double workerUtilizationHint) 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.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RuntimeUpdatableParams

public RuntimeUpdatableParams()

Method Detail

getMaxNumWorkers

public Integer getMaxNumWorkers()

The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.

Returns:

value or null for none

setMaxNumWorkers

public RuntimeUpdatableParams setMaxNumWorkers(Integer maxNumWorkers)

The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.

Parameters:

maxNumWorkers - maxNumWorkers or null for none

getMinNumWorkers

public Integer getMinNumWorkers()

The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.

Returns:

value or null for none

setMinNumWorkers

public RuntimeUpdatableParams setMinNumWorkers(Integer minNumWorkers)

The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.

Parameters:

minNumWorkers - minNumWorkers or null for none

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).

Returns:

value or null for none

setWorkerUtilizationHint

public RuntimeUpdatableParams setWorkerUtilizationHint(Double workerUtilizationHint)

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).

Parameters:

workerUtilizationHint - workerUtilizationHint or null for none

set

public RuntimeUpdatableParams set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RuntimeUpdatableParams clone()

Overrides:

clone in class com.google.api.client.json.GenericJson