com.google.api.services.dataflow.model

Class TaskRunnerSettings

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataflow.model.TaskRunnerSettings

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Taskrunner configuration settings.

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 Google 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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TaskRunnerSettings()

Method Summary

Methods

Modifier and Type	Method and Description
TaskRunnerSettings	clone()
java.lang.Boolean	getAlsologtostderr() Whether to also send taskrunner log info to stderr.
java.lang.String	getBaseTaskDir() The location on the worker for task-specific subdirectories.
java.lang.String	getBaseUrl() The base URL for the taskrunner to use when accessing Google Cloud APIs.
java.lang.String	getCommandlinesFileName() The file to store preprocessing commands in.
java.lang.Boolean	getContinueOnException() Whether to continue taskrunner if an exception is hit.
java.lang.String	getDataflowApiVersion() The API version of endpoint, e.g.
java.lang.String	getHarnessCommand() The command to launch the worker harness.
java.lang.String	getLanguageHint() The suggested backend language.
java.lang.String	getLogDir() The directory on the VM to store logs.
java.lang.Boolean	getLogToSerialconsole() Whether to send taskrunner log info to Google Compute Engine VM serial console.
java.lang.String	getLogUploadLocation() Indicates where to put logs.
java.util.List<java.lang.String>	getOauthScopes() The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.
WorkerSettings	getParallelWorkerSettings() The settings to pass to the parallel worker harness.
java.lang.String	getStreamingWorkerMainClass() The streaming worker main class name.
java.lang.String	getTaskGroup() The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g.
java.lang.String	getTaskUser() The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g.
java.lang.String	getTempStoragePrefix() The prefix of the resources the taskrunner should use for temporary storage.
java.lang.String	getVmId() The ID string of the VM.
java.lang.String	getWorkflowFileName() The file to store the workflow in.
TaskRunnerSettings	set(java.lang.String fieldName, java.lang.Object value)
TaskRunnerSettings	setAlsologtostderr(java.lang.Boolean alsologtostderr) Whether to also send taskrunner log info to stderr.
TaskRunnerSettings	setBaseTaskDir(java.lang.String baseTaskDir) The location on the worker for task-specific subdirectories.
TaskRunnerSettings	setBaseUrl(java.lang.String baseUrl) The base URL for the taskrunner to use when accessing Google Cloud APIs.
TaskRunnerSettings	setCommandlinesFileName(java.lang.String commandlinesFileName) The file to store preprocessing commands in.
TaskRunnerSettings	setContinueOnException(java.lang.Boolean continueOnException) Whether to continue taskrunner if an exception is hit.
TaskRunnerSettings	setDataflowApiVersion(java.lang.String dataflowApiVersion) The API version of endpoint, e.g.
TaskRunnerSettings	setHarnessCommand(java.lang.String harnessCommand) The command to launch the worker harness.
TaskRunnerSettings	setLanguageHint(java.lang.String languageHint) The suggested backend language.
TaskRunnerSettings	setLogDir(java.lang.String logDir) The directory on the VM to store logs.
TaskRunnerSettings	setLogToSerialconsole(java.lang.Boolean logToSerialconsole) Whether to send taskrunner log info to Google Compute Engine VM serial console.
TaskRunnerSettings	setLogUploadLocation(java.lang.String logUploadLocation) Indicates where to put logs.
TaskRunnerSettings	setOauthScopes(java.util.List<java.lang.String> oauthScopes) The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.
TaskRunnerSettings	setParallelWorkerSettings(WorkerSettings parallelWorkerSettings) The settings to pass to the parallel worker harness.
TaskRunnerSettings	setStreamingWorkerMainClass(java.lang.String streamingWorkerMainClass) The streaming worker main class name.
TaskRunnerSettings	setTaskGroup(java.lang.String taskGroup) The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g.
TaskRunnerSettings	setTaskUser(java.lang.String taskUser) The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g.
TaskRunnerSettings	setTempStoragePrefix(java.lang.String tempStoragePrefix) The prefix of the resources the taskrunner should use for temporary storage.
TaskRunnerSettings	setVmId(java.lang.String vmId) The ID string of the VM.
TaskRunnerSettings	setWorkflowFileName(java.lang.String workflowFileName) The file to store the workflow in.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskRunnerSettings

public TaskRunnerSettings()

Method Detail

getAlsologtostderr

public java.lang.Boolean getAlsologtostderr()

Whether to also send taskrunner log info to stderr.

Returns:

value or null for none

setAlsologtostderr

public TaskRunnerSettings setAlsologtostderr(java.lang.Boolean alsologtostderr)

Whether to also send taskrunner log info to stderr.

Parameters:

alsologtostderr - alsologtostderr or null for none

getBaseTaskDir

public java.lang.String getBaseTaskDir()

The location on the worker for task-specific subdirectories.

Returns:

value or null for none

setBaseTaskDir

public TaskRunnerSettings setBaseTaskDir(java.lang.String baseTaskDir)

The location on the worker for task-specific subdirectories.

Parameters:

baseTaskDir - baseTaskDir or null for none

getBaseUrl

public java.lang.String getBaseUrl()

The base URL for the taskrunner to use when 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 TaskRunnerSettings setBaseUrl(java.lang.String baseUrl)

The base URL for the taskrunner to use when 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

getCommandlinesFileName

public java.lang.String getCommandlinesFileName()

The file to store preprocessing commands in.

Returns:

value or null for none

setCommandlinesFileName

public TaskRunnerSettings setCommandlinesFileName(java.lang.String commandlinesFileName)

The file to store preprocessing commands in.

Parameters:

commandlinesFileName - commandlinesFileName or null for none

getContinueOnException

public java.lang.Boolean getContinueOnException()

Whether to continue taskrunner if an exception is hit.

Returns:

value or null for none

setContinueOnException

public TaskRunnerSettings setContinueOnException(java.lang.Boolean continueOnException)

Whether to continue taskrunner if an exception is hit.

Parameters:

continueOnException - continueOnException or null for none

getDataflowApiVersion

public java.lang.String getDataflowApiVersion()

The API version of endpoint, e.g. "v1b3"

Returns:

value or null for none

setDataflowApiVersion

public TaskRunnerSettings setDataflowApiVersion(java.lang.String dataflowApiVersion)

The API version of endpoint, e.g. "v1b3"

Parameters:

dataflowApiVersion - dataflowApiVersion or null for none

getHarnessCommand

public java.lang.String getHarnessCommand()

The command to launch the worker harness.

Returns:

value or null for none

setHarnessCommand

public TaskRunnerSettings setHarnessCommand(java.lang.String harnessCommand)

The command to launch the worker harness.

Parameters:

harnessCommand - harnessCommand or null for none

getLanguageHint

public java.lang.String getLanguageHint()

The suggested backend language.

Returns:

value or null for none

setLanguageHint

public TaskRunnerSettings setLanguageHint(java.lang.String languageHint)

The suggested backend language.

Parameters:

languageHint - languageHint or null for none

getLogDir

public java.lang.String getLogDir()

The directory on the VM to store logs.

Returns:

value or null for none

setLogDir

public TaskRunnerSettings setLogDir(java.lang.String logDir)

The directory on the VM to store logs.

Parameters:

logDir - logDir or null for none

getLogToSerialconsole

public java.lang.Boolean getLogToSerialconsole()

Whether to send taskrunner log info to Google Compute Engine VM serial console.

Returns:

value or null for none

setLogToSerialconsole

public TaskRunnerSettings setLogToSerialconsole(java.lang.Boolean logToSerialconsole)

Whether to send taskrunner log info to Google Compute Engine VM serial console.

Parameters:

logToSerialconsole - logToSerialconsole or null for none

getLogUploadLocation

public java.lang.String getLogUploadLocation()

Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

Returns:

value or null for none

setLogUploadLocation

public TaskRunnerSettings setLogUploadLocation(java.lang.String logUploadLocation)

Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

Parameters:

logUploadLocation - logUploadLocation or null for none

getOauthScopes

public java.util.List<java.lang.String> getOauthScopes()

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

Returns:

value or null for none

setOauthScopes

public TaskRunnerSettings setOauthScopes(java.util.List<java.lang.String> oauthScopes)

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

Parameters:

oauthScopes - oauthScopes or null for none

getParallelWorkerSettings

public WorkerSettings getParallelWorkerSettings()

The settings to pass to the parallel worker harness.

Returns:

value or null for none

setParallelWorkerSettings

public TaskRunnerSettings setParallelWorkerSettings(WorkerSettings parallelWorkerSettings)

The settings to pass to the parallel worker harness.

Parameters:

parallelWorkerSettings - parallelWorkerSettings or null for none

getStreamingWorkerMainClass

public java.lang.String getStreamingWorkerMainClass()

The streaming worker main class name.

Returns:

value or null for none

setStreamingWorkerMainClass

public TaskRunnerSettings setStreamingWorkerMainClass(java.lang.String streamingWorkerMainClass)

The streaming worker main class name.

Parameters:

streamingWorkerMainClass - streamingWorkerMainClass or null for none

getTaskGroup

public java.lang.String getTaskGroup()

The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

Returns:

value or null for none

setTaskGroup

public TaskRunnerSettings setTaskGroup(java.lang.String taskGroup)

The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

Parameters:

taskGroup - taskGroup or null for none

getTaskUser

public java.lang.String getTaskUser()

The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

Returns:

value or null for none

setTaskUser

public TaskRunnerSettings setTaskUser(java.lang.String taskUser)

The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

Parameters:

taskUser - taskUser or null for none

getTempStoragePrefix

public java.lang.String getTempStoragePrefix()

The prefix of the resources the taskrunner 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 TaskRunnerSettings setTempStoragePrefix(java.lang.String tempStoragePrefix)

The prefix of the resources the taskrunner 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

getVmId

public java.lang.String getVmId()

The ID string of the VM.

Returns:

value or null for none

setVmId

public TaskRunnerSettings setVmId(java.lang.String vmId)

The ID string of the VM.

Parameters:

vmId - vmId or null for none

getWorkflowFileName

public java.lang.String getWorkflowFileName()

The file to store the workflow in.

Returns:

value or null for none

setWorkflowFileName

public TaskRunnerSettings setWorkflowFileName(java.lang.String workflowFileName)

The file to store the workflow in.

Parameters:

workflowFileName - workflowFileName or null for none

set

public TaskRunnerSettings set(java.lang.String fieldName,
                     java.lang.Object value)

Overrides:

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

clone

public TaskRunnerSettings clone()

Overrides:

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