WorkerMessage (Dataflow API v1b3 (Rev. 237) 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.WorkerMessage

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class WorkerMessage
extends com.google.api.client.json.GenericJson
```
WorkerMessage provides information to the backend about a worker.
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

WorkerMessage()

Constructors
Constructor and Description
`WorkerMessage()`

Method Summary

Methods
Modifier and Type	Method and Description
`WorkerMessage`	`clone()`
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` Labels are used to group WorkerMessages.
`java.lang.String`	`getTime()` The timestamp of the worker_message.
`WorkerHealthReport`	`getWorkerHealthReport()` The health of a worker.
`WorkerLifecycleEvent`	`getWorkerLifecycleEvent()` Record of worker lifecycle events.
`WorkerMessageCode`	`getWorkerMessageCode()` A worker message code.
`ResourceUtilizationReport`	`getWorkerMetrics()` Resource metrics reported by workers.
`WorkerShutdownNotice`	`getWorkerShutdownNotice()` Shutdown notice by workers.
`WorkerMessage`	`set(java.lang.String fieldName, java.lang.Object value)`
`WorkerMessage`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` Labels are used to group WorkerMessages.
`WorkerMessage`	`setTime(java.lang.String time)` The timestamp of the worker_message.
`WorkerMessage`	`setWorkerHealthReport(WorkerHealthReport workerHealthReport)` The health of a worker.
`WorkerMessage`	`setWorkerLifecycleEvent(WorkerLifecycleEvent workerLifecycleEvent)` Record of worker lifecycle events.
`WorkerMessage`	`setWorkerMessageCode(WorkerMessageCode workerMessageCode)` A worker message code.
`WorkerMessage`	`setWorkerMetrics(ResourceUtilizationReport workerMetrics)` Resource metrics reported by workers.
`WorkerMessage`	`setWorkerShutdownNotice(WorkerShutdownNotice workerShutdownNotice)` Shutdown notice by workers.

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
  - WorkerMessage
```
public WorkerMessage()
```
- Method Detail
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
    Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here.
    
    Returns:
    value or null for none
  - setLabels
```
public WorkerMessage setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
    Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here.
    
    Parameters:
    labels - labels or null for none
  - getTime
```
public java.lang.String getTime()
```
    The timestamp of the worker_message.
    
    Returns:
    value or null for none
  - setTime
```
public WorkerMessage setTime(java.lang.String time)
```
    The timestamp of the worker_message.
    
    Parameters:
    time - time or null for none
  - getWorkerHealthReport
```
public WorkerHealthReport getWorkerHealthReport()
```
    The health of a worker.
    
    Returns:
    value or null for none
  - setWorkerHealthReport
```
public WorkerMessage setWorkerHealthReport(WorkerHealthReport workerHealthReport)
```
    The health of a worker.
    
    Parameters:
    workerHealthReport - workerHealthReport or null for none
  - getWorkerLifecycleEvent
```
public WorkerLifecycleEvent getWorkerLifecycleEvent()
```
    Record of worker lifecycle events.
    
    Returns:
    value or null for none
  - setWorkerLifecycleEvent
```
public WorkerMessage setWorkerLifecycleEvent(WorkerLifecycleEvent workerLifecycleEvent)
```
    Record of worker lifecycle events.
    
    Parameters:
    workerLifecycleEvent - workerLifecycleEvent or null for none
  - getWorkerMessageCode
```
public WorkerMessageCode getWorkerMessageCode()
```
    A worker message code.
    
    Returns:
    value or null for none
  - setWorkerMessageCode
```
public WorkerMessage setWorkerMessageCode(WorkerMessageCode workerMessageCode)
```
    A worker message code.
    
    Parameters:
    workerMessageCode - workerMessageCode or null for none
  - getWorkerMetrics
```
public ResourceUtilizationReport getWorkerMetrics()
```
    Resource metrics reported by workers.
    
    Returns:
    value or null for none
  - setWorkerMetrics
```
public WorkerMessage setWorkerMetrics(ResourceUtilizationReport workerMetrics)
```
    Resource metrics reported by workers.
    
    Parameters:
    workerMetrics - workerMetrics or null for none
  - getWorkerShutdownNotice
```
public WorkerShutdownNotice getWorkerShutdownNotice()
```
    Shutdown notice by workers.
    
    Returns:
    value or null for none
  - setWorkerShutdownNotice
```
public WorkerMessage setWorkerShutdownNotice(WorkerShutdownNotice workerShutdownNotice)
```
    Shutdown notice by workers.
    
    Parameters:
    workerShutdownNotice - workerShutdownNotice or null for none
  - set
```
public WorkerMessage set(java.lang.String fieldName,
                java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public WorkerMessage clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Dataflow API v1b3 (revision 237)

Class WorkerMessage

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

Constructor Detail

WorkerMessage

Method Detail

getLabels

setLabels

getTime

setTime

getWorkerHealthReport

setWorkerHealthReport

getWorkerLifecycleEvent

setWorkerLifecycleEvent

getWorkerMessageCode

setWorkerMessageCode

getWorkerMetrics

setWorkerMetrics

getWorkerShutdownNotice

setWorkerShutdownNotice

set

clone