com.google.api.services.dataflow.model

Class WorkerSettings

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class WorkerSettings
extends GenericJson

Provides data to pass through to the worker harness.

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

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

Method Summary

Modifier and Type	Method and Description
WorkerSettings	clone()
String	getBaseUrl() The base URL for accessing Google Cloud APIs.
Boolean	getReportingEnabled() Whether to send work progress updates to the service.
String	getServicePath() The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
String	getShuffleServicePath() The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
String	getTempStoragePrefix() The prefix of the resources the system should use for temporary storage.
String	getWorkerId() The ID of the worker running this pipeline.
WorkerSettings	set(String fieldName, Object value)
WorkerSettings	setBaseUrl(String baseUrl) The base URL for accessing Google Cloud APIs.
WorkerSettings	setReportingEnabled(Boolean reportingEnabled) Whether to send work progress updates to the service.
WorkerSettings	setServicePath(String servicePath) The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
WorkerSettings	setShuffleServicePath(String shuffleServicePath) The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
WorkerSettings	setTempStoragePrefix(String tempStoragePrefix) The prefix of the resources the system should use for temporary storage.
WorkerSettings	setWorkerId(String workerId) The ID of the worker running this pipeline.

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

WorkerSettings

public WorkerSettings()

Method Detail

getBaseUrl

public String getBaseUrl()

The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"

Returns:

value or null for none

setBaseUrl

public WorkerSettings setBaseUrl(String baseUrl)

The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"

Parameters:

baseUrl - baseUrl or null for none

getReportingEnabled

public Boolean getReportingEnabled()

Whether to send work progress updates to the service.

Returns:

value or null for none

setReportingEnabled

public WorkerSettings setReportingEnabled(Boolean reportingEnabled)

Whether to send work progress updates to the service.

Parameters:

reportingEnabled - reportingEnabled or null for none

getServicePath

public String getServicePath()

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

Returns:

value or null for none

setServicePath

public WorkerSettings setServicePath(String servicePath)

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

Parameters:

servicePath - servicePath or null for none

getShuffleServicePath

public String getShuffleServicePath()

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

Returns:

value or null for none

setShuffleServicePath

public WorkerSettings setShuffleServicePath(String shuffleServicePath)

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

Parameters:

shuffleServicePath - shuffleServicePath or null for none

getTempStoragePrefix

public String getTempStoragePrefix()

The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

Returns:

value or null for none

setTempStoragePrefix

public WorkerSettings setTempStoragePrefix(String tempStoragePrefix)

The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

Parameters:

tempStoragePrefix - tempStoragePrefix or null for none

getWorkerId

public String getWorkerId()

The ID of the worker running this pipeline.

Returns:

value or null for none

setWorkerId

public WorkerSettings setWorkerId(String workerId)

The ID of the worker running this pipeline.

Parameters:

workerId - workerId or null for none

set

public WorkerSettings set(String fieldName,
                          Object value)

Overrides:

set in class GenericJson

clone

public WorkerSettings clone()

Overrides:

clone in class GenericJson