WorkerSettings (Dataflow API v1b3 (Rev. 257) 1.23.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class WorkerSettings
extends com.google.api.client.json.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
  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

WorkerSettings()

Constructors
Constructor and Description
`WorkerSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkerSettings`	`clone()`
`java.lang.String`	`getBaseUrl()` The base URL for accessing Google Cloud APIs.
`java.lang.Boolean`	`getReportingEnabled()` Whether to send work progress updates to the service.
`java.lang.String`	`getServicePath()` The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
`java.lang.String`	`getShuffleServicePath()` The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
`java.lang.String`	`getTempStoragePrefix()` The prefix of the resources the system should use for temporary storage.
`java.lang.String`	`getWorkerId()` The ID of the worker running this pipeline.
`WorkerSettings`	`set(java.lang.String fieldName, java.lang.Object value)`
`WorkerSettings`	`setBaseUrl(java.lang.String baseUrl)` The base URL for accessing Google Cloud APIs.
`WorkerSettings`	`setReportingEnabled(java.lang.Boolean reportingEnabled)` Whether to send work progress updates to the service.
`WorkerSettings`	`setServicePath(java.lang.String servicePath)` The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
`WorkerSettings`	`setShuffleServicePath(java.lang.String shuffleServicePath)` The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
`WorkerSettings`	`setTempStoragePrefix(java.lang.String tempStoragePrefix)` The prefix of the resources the system should use for temporary storage.
`WorkerSettings`	`setWorkerId(java.lang.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, 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
  - WorkerSettings
```
public WorkerSettings()
```
- Method Detail
  - getBaseUrl
```
public java.lang.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(java.lang.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 java.lang.Boolean getReportingEnabled()
```
    Whether to send work progress updates to the service.
    
    Returns:
    
    value or null for none
  - setReportingEnabled
```
public WorkerSettings setReportingEnabled(java.lang.Boolean reportingEnabled)
```
    Whether to send work progress updates to the service.
    
    Parameters:
    
    reportingEnabled - reportingEnabled or null for none
  - getServicePath
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.String shuffleServicePath)
```
    The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
    
    Parameters:
    
    shuffleServicePath - shuffleServicePath or null for none
  - getTempStoragePrefix
```
public java.lang.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(java.lang.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 java.lang.String getWorkerId()
```
    The ID of the worker running this pipeline.
    
    Returns:
    
    value or null for none
  - setWorkerId
```
public WorkerSettings setWorkerId(java.lang.String workerId)
```
    The ID of the worker running this pipeline.
    
    Parameters:
    
    workerId - workerId or null for none
  - set
```
public WorkerSettings set(java.lang.String fieldName,
                          java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public WorkerSettings clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Dataflow API v1b3 (revision 257)

Class WorkerSettings

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

WorkerSettings

Method Detail

getBaseUrl

setBaseUrl

getReportingEnabled

setReportingEnabled

getServicePath

setServicePath

getShuffleServicePath

setShuffleServicePath

getTempStoragePrefix

setTempStoragePrefix

getWorkerId

setWorkerId

set

clone