TaskRunnerSettings (Dataflow API v1b3-rev20181107-1.26.0)

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

All Implemented Interfaces:

Cloneable, Map<String,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 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

TaskRunnerSettings()

Constructors
Constructor and Description
`TaskRunnerSettings()`

Method Summary

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - TaskRunnerSettings
```
public TaskRunnerSettings()
```
- Method Detail
  - getAlsologtostderr
```
public Boolean getAlsologtostderr()
```
    Whether to also send taskrunner log info to stderr.
    
    Returns:
    
    value or null for none
  - setAlsologtostderr
```
public TaskRunnerSettings setAlsologtostderr(Boolean alsologtostderr)
```
    Whether to also send taskrunner log info to stderr.
    
    Parameters:
    
    alsologtostderr - alsologtostderr or null for none
  - getBaseTaskDir
```
public String getBaseTaskDir()
```
    The location on the worker for task-specific subdirectories.
    
    Returns:
    
    value or null for none
  - setBaseTaskDir
```
public TaskRunnerSettings setBaseTaskDir(String baseTaskDir)
```
    The location on the worker for task-specific subdirectories.
    
    Parameters:
    
    baseTaskDir - baseTaskDir or null for none
  - getBaseUrl
```
public 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(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 String getCommandlinesFileName()
```
    The file to store preprocessing commands in.
    
    Returns:
    
    value or null for none
  - setCommandlinesFileName
```
public TaskRunnerSettings setCommandlinesFileName(String commandlinesFileName)
```
    The file to store preprocessing commands in.
    
    Parameters:
    
    commandlinesFileName - commandlinesFileName or null for none
  - getContinueOnException
```
public Boolean getContinueOnException()
```
    Whether to continue taskrunner if an exception is hit.
    
    Returns:
    
    value or null for none
  - setContinueOnException
```
public TaskRunnerSettings setContinueOnException(Boolean continueOnException)
```
    Whether to continue taskrunner if an exception is hit.
    
    Parameters:
    
    continueOnException - continueOnException or null for none
  - getDataflowApiVersion
```
public String getDataflowApiVersion()
```
    The API version of endpoint, e.g. "v1b3"
    
    Returns:
    
    value or null for none
  - setDataflowApiVersion
```
public TaskRunnerSettings setDataflowApiVersion(String dataflowApiVersion)
```
    The API version of endpoint, e.g. "v1b3"
    
    Parameters:
    
    dataflowApiVersion - dataflowApiVersion or null for none
  - getHarnessCommand
```
public String getHarnessCommand()
```
    The command to launch the worker harness.
    
    Returns:
    
    value or null for none
  - setHarnessCommand
```
public TaskRunnerSettings setHarnessCommand(String harnessCommand)
```
    The command to launch the worker harness.
    
    Parameters:
    
    harnessCommand - harnessCommand or null for none
  - getLanguageHint
```
public String getLanguageHint()
```
    The suggested backend language.
    
    Returns:
    
    value or null for none
  - setLanguageHint
```
public TaskRunnerSettings setLanguageHint(String languageHint)
```
    The suggested backend language.
    
    Parameters:
    
    languageHint - languageHint or null for none
  - getLogDir
```
public String getLogDir()
```
    The directory on the VM to store logs.
    
    Returns:
    
    value or null for none
  - setLogDir
```
public TaskRunnerSettings setLogDir(String logDir)
```
    The directory on the VM to store logs.
    
    Parameters:
    
    logDir - logDir or null for none
  - getLogToSerialconsole
```
public 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(Boolean logToSerialconsole)
```
    Whether to send taskrunner log info to Google Compute Engine VM serial console.
    
    Parameters:
    
    logToSerialconsole - logToSerialconsole or null for none
  - getLogUploadLocation
```
public 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(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 List<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(List<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 String getStreamingWorkerMainClass()
```
    The streaming worker main class name.
    
    Returns:
    
    value or null for none
  - setStreamingWorkerMainClass
```
public TaskRunnerSettings setStreamingWorkerMainClass(String streamingWorkerMainClass)
```
    The streaming worker main class name.
    
    Parameters:
    
    streamingWorkerMainClass - streamingWorkerMainClass or null for none
  - getTaskGroup
```
public 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(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 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(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 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(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 String getVmId()
```
    The ID string of the VM.
    
    Returns:
    
    value or null for none
  - setVmId
```
public TaskRunnerSettings setVmId(String vmId)
```
    The ID string of the VM.
    
    Parameters:
    
    vmId - vmId or null for none
  - getWorkflowFileName
```
public String getWorkflowFileName()
```
    The file to store the workflow in.
    
    Returns:
    
    value or null for none
  - setWorkflowFileName
```
public TaskRunnerSettings setWorkflowFileName(String workflowFileName)
```
    The file to store the workflow in.
    
    Parameters:
    
    workflowFileName - workflowFileName or null for none
  - set
```
public TaskRunnerSettings set(String fieldName,
                              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

Class TaskRunnerSettings

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

TaskRunnerSettings

Method Detail

getAlsologtostderr

setAlsologtostderr

getBaseTaskDir

setBaseTaskDir

getBaseUrl

setBaseUrl

getCommandlinesFileName

setCommandlinesFileName

getContinueOnException

setContinueOnException

getDataflowApiVersion

setDataflowApiVersion

getHarnessCommand

setHarnessCommand

getLanguageHint

setLanguageHint

getLogDir

setLogDir

getLogToSerialconsole

setLogToSerialconsole

getLogUploadLocation

setLogUploadLocation

getOauthScopes

setOauthScopes

getParallelWorkerSettings

setParallelWorkerSettings

getStreamingWorkerMainClass

setStreamingWorkerMainClass

getTaskGroup

setTaskGroup

getTaskUser

setTaskUser

getTempStoragePrefix

setTempStoragePrefix

getVmId

setVmId

getWorkflowFileName

setWorkflowFileName

set

clone