com.google.api.services.dataflow.model

Class StreamingConfigTask

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A task that carries configuration information for streaming computations.

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
StreamingConfigTask()

Method Summary

Modifier and Type	Method and Description
StreamingConfigTask	clone()
byte[]	decodeUserWorkerRunnerV1Settings() Binary encoded proto to control runtime behavior of the java runner v1 user worker.
byte[]	decodeUserWorkerRunnerV2Settings() Binary encoded proto to control runtime behavior of the runner v2 user worker.
StreamingConfigTask	encodeUserWorkerRunnerV1Settings(byte[] userWorkerRunnerV1Settings) Binary encoded proto to control runtime behavior of the java runner v1 user worker.
StreamingConfigTask	encodeUserWorkerRunnerV2Settings(byte[] userWorkerRunnerV2Settings) Binary encoded proto to control runtime behavior of the runner v2 user worker.
Long	getCommitStreamChunkSizeBytes() Chunk size for commit streams from the harness to windmill.
Long	getGetDataStreamChunkSizeBytes() Chunk size for get data streams from the harness to windmill.
Long	getMaxWorkItemCommitBytes() Maximum size for work item commit supported windmill storage layer.
StreamingOperationalLimits	getOperationalLimits() Operational limits for the streaming job.
List<StreamingComputationConfig>	getStreamingComputationConfigs() Set of computation configuration information.
Map<String,String>	getUserStepToStateFamilyNameMap() Map from user step names to state families.
String	getUserWorkerRunnerV1Settings() Binary encoded proto to control runtime behavior of the java runner v1 user worker.
String	getUserWorkerRunnerV2Settings() Binary encoded proto to control runtime behavior of the runner v2 user worker.
String	getWindmillServiceEndpoint() If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using.
Long	getWindmillServicePort() If present, the worker must use this port to communicate with Windmill Service dispatchers.
StreamingConfigTask	set(String fieldName, Object value)
StreamingConfigTask	setCommitStreamChunkSizeBytes(Long commitStreamChunkSizeBytes) Chunk size for commit streams from the harness to windmill.
StreamingConfigTask	setGetDataStreamChunkSizeBytes(Long getDataStreamChunkSizeBytes) Chunk size for get data streams from the harness to windmill.
StreamingConfigTask	setMaxWorkItemCommitBytes(Long maxWorkItemCommitBytes) Maximum size for work item commit supported windmill storage layer.
StreamingConfigTask	setOperationalLimits(StreamingOperationalLimits operationalLimits) Operational limits for the streaming job.
StreamingConfigTask	setStreamingComputationConfigs(List<StreamingComputationConfig> streamingComputationConfigs) Set of computation configuration information.
StreamingConfigTask	setUserStepToStateFamilyNameMap(Map<String,String> userStepToStateFamilyNameMap) Map from user step names to state families.
StreamingConfigTask	setUserWorkerRunnerV1Settings(String userWorkerRunnerV1Settings) Binary encoded proto to control runtime behavior of the java runner v1 user worker.
StreamingConfigTask	setUserWorkerRunnerV2Settings(String userWorkerRunnerV2Settings) Binary encoded proto to control runtime behavior of the runner v2 user worker.
StreamingConfigTask	setWindmillServiceEndpoint(String windmillServiceEndpoint) If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using.
StreamingConfigTask	setWindmillServicePort(Long windmillServicePort) If present, the worker must use this port to communicate with Windmill Service dispatchers.

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

StreamingConfigTask

public StreamingConfigTask()

Method Detail

getCommitStreamChunkSizeBytes

public Long getCommitStreamChunkSizeBytes()

Chunk size for commit streams from the harness to windmill.

Returns:

value or null for none

setCommitStreamChunkSizeBytes

public StreamingConfigTask setCommitStreamChunkSizeBytes(Long commitStreamChunkSizeBytes)

Chunk size for commit streams from the harness to windmill.

Parameters:

commitStreamChunkSizeBytes - commitStreamChunkSizeBytes or null for none

getGetDataStreamChunkSizeBytes

public Long getGetDataStreamChunkSizeBytes()

Chunk size for get data streams from the harness to windmill.

Returns:

value or null for none

setGetDataStreamChunkSizeBytes

public StreamingConfigTask setGetDataStreamChunkSizeBytes(Long getDataStreamChunkSizeBytes)

Chunk size for get data streams from the harness to windmill.

Parameters:

getDataStreamChunkSizeBytes - getDataStreamChunkSizeBytes or null for none

getMaxWorkItemCommitBytes

public Long getMaxWorkItemCommitBytes()

Maximum size for work item commit supported windmill storage layer.

Returns:

value or null for none

setMaxWorkItemCommitBytes

public StreamingConfigTask setMaxWorkItemCommitBytes(Long maxWorkItemCommitBytes)

Maximum size for work item commit supported windmill storage layer.

Parameters:

maxWorkItemCommitBytes - maxWorkItemCommitBytes or null for none

getOperationalLimits

public StreamingOperationalLimits getOperationalLimits()

Operational limits for the streaming job. Can be used by the worker to validate outputs sent to the backend.

Returns:

value or null for none

setOperationalLimits

public StreamingConfigTask setOperationalLimits(StreamingOperationalLimits operationalLimits)

Operational limits for the streaming job. Can be used by the worker to validate outputs sent to the backend.

Parameters:

operationalLimits - operationalLimits or null for none

getStreamingComputationConfigs

public List<StreamingComputationConfig> getStreamingComputationConfigs()

Set of computation configuration information.

Returns:

value or null for none

setStreamingComputationConfigs

public StreamingConfigTask setStreamingComputationConfigs(List<StreamingComputationConfig> streamingComputationConfigs)

Set of computation configuration information.

Parameters:

streamingComputationConfigs - streamingComputationConfigs or null for none

getUserStepToStateFamilyNameMap

public Map<String,String> getUserStepToStateFamilyNameMap()

Map from user step names to state families.

Returns:

value or null for none

setUserStepToStateFamilyNameMap

public StreamingConfigTask setUserStepToStateFamilyNameMap(Map<String,String> userStepToStateFamilyNameMap)

Map from user step names to state families.

Parameters:

userStepToStateFamilyNameMap - userStepToStateFamilyNameMap or null for none

getUserWorkerRunnerV1Settings

public String getUserWorkerRunnerV1Settings()

Binary encoded proto to control runtime behavior of the java runner v1 user worker.

Returns:

value or null for none

See Also:

decodeUserWorkerRunnerV1Settings()

decodeUserWorkerRunnerV1Settings

public byte[] decodeUserWorkerRunnerV1Settings()

Binary encoded proto to control runtime behavior of the java runner v1 user worker.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getUserWorkerRunnerV1Settings()

setUserWorkerRunnerV1Settings

public StreamingConfigTask setUserWorkerRunnerV1Settings(String userWorkerRunnerV1Settings)

Binary encoded proto to control runtime behavior of the java runner v1 user worker.

Parameters:

userWorkerRunnerV1Settings - userWorkerRunnerV1Settings or null for none

See Also:

#encodeUserWorkerRunnerV1Settings()

encodeUserWorkerRunnerV1Settings

public StreamingConfigTask encodeUserWorkerRunnerV1Settings(byte[] userWorkerRunnerV1Settings)

Binary encoded proto to control runtime behavior of the java runner v1 user worker.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getUserWorkerRunnerV2Settings

public String getUserWorkerRunnerV2Settings()

Binary encoded proto to control runtime behavior of the runner v2 user worker.

Returns:

value or null for none

See Also:

decodeUserWorkerRunnerV2Settings()

decodeUserWorkerRunnerV2Settings

public byte[] decodeUserWorkerRunnerV2Settings()

Binary encoded proto to control runtime behavior of the runner v2 user worker.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getUserWorkerRunnerV2Settings()

setUserWorkerRunnerV2Settings

public StreamingConfigTask setUserWorkerRunnerV2Settings(String userWorkerRunnerV2Settings)

Binary encoded proto to control runtime behavior of the runner v2 user worker.

Parameters:

userWorkerRunnerV2Settings - userWorkerRunnerV2Settings or null for none

See Also:

#encodeUserWorkerRunnerV2Settings()

encodeUserWorkerRunnerV2Settings

public StreamingConfigTask encodeUserWorkerRunnerV2Settings(byte[] userWorkerRunnerV2Settings)

Binary encoded proto to control runtime behavior of the runner v2 user worker.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getWindmillServiceEndpoint

public String getWindmillServiceEndpoint()

If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using.

Returns:

value or null for none

setWindmillServiceEndpoint

public StreamingConfigTask setWindmillServiceEndpoint(String windmillServiceEndpoint)

If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using.

Parameters:

windmillServiceEndpoint - windmillServiceEndpoint or null for none

getWindmillServicePort

public Long getWindmillServicePort()

If present, the worker must use this port to communicate with Windmill Service dispatchers. Only applicable when windmill_service_endpoint is specified.

Returns:

value or null for none

setWindmillServicePort

public StreamingConfigTask setWindmillServicePort(Long windmillServicePort)

If present, the worker must use this port to communicate with Windmill Service dispatchers. Only applicable when windmill_service_endpoint is specified.

Parameters:

windmillServicePort - windmillServicePort or null for none

set

public StreamingConfigTask set(String fieldName,
                               Object value)

Overrides:

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

clone

public StreamingConfigTask clone()

Overrides:

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