WorkerMessage (Dataflow API v1b3-rev20240817-2.0.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.WorkerMessage

All Implemented Interfaces:

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

WorkerMessage()

Constructors
Constructor and Description
`WorkerMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkerMessage`	`clone()`
`DataSamplingReport`	`getDataSamplingReport()` Optional.
`Map<String,String>`	`getLabels()` Labels are used to group WorkerMessages.
`PerWorkerMetrics`	`getPerWorkerMetrics()` System defined metrics for this worker.
`StreamingScalingReport`	`getStreamingScalingReport()` Contains per-user worker telemetry used in streaming autoscaling.
`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.
`WorkerThreadScalingReport`	`getWorkerThreadScalingReport()` Thread scaling information reported by workers.
`WorkerMessage`	`set(String fieldName, Object value)`
`WorkerMessage`	`setDataSamplingReport(DataSamplingReport dataSamplingReport)` Optional.
`WorkerMessage`	`setLabels(Map<String,String> labels)` Labels are used to group WorkerMessages.
`WorkerMessage`	`setPerWorkerMetrics(PerWorkerMetrics perWorkerMetrics)` System defined metrics for this worker.
`WorkerMessage`	`setStreamingScalingReport(StreamingScalingReport streamingScalingReport)` Contains per-user worker telemetry used in streaming autoscaling.
`WorkerMessage`	`setTime(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.
`WorkerMessage`	`setWorkerThreadScalingReport(WorkerThreadScalingReport workerThreadScalingReport)` Thread scaling information reported 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, 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
  - WorkerMessage
```
public WorkerMessage()
```
- Method Detail
  - getDataSamplingReport
```
public DataSamplingReport getDataSamplingReport()
```
    Optional. Contains metrics related to go/dataflow-data-sampling-telemetry.
    
    Returns:
    
    value or null for none
  - setDataSamplingReport
```
public WorkerMessage setDataSamplingReport(DataSamplingReport dataSamplingReport)
```
    Optional. Contains metrics related to go/dataflow-data-sampling-telemetry.
    
    Parameters:
    
    dataSamplingReport - dataSamplingReport or null for none
  - getLabels
```
public Map<String,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(Map<String,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
  - getPerWorkerMetrics
```
public PerWorkerMetrics getPerWorkerMetrics()
```
    System defined metrics for this worker.
    
    Returns:
    
    value or null for none
  - setPerWorkerMetrics
```
public WorkerMessage setPerWorkerMetrics(PerWorkerMetrics perWorkerMetrics)
```
    System defined metrics for this worker.
    
    Parameters:
    
    perWorkerMetrics - perWorkerMetrics or null for none
  - getStreamingScalingReport
```
public StreamingScalingReport getStreamingScalingReport()
```
    Contains per-user worker telemetry used in streaming autoscaling.
    
    Returns:
    
    value or null for none
  - setStreamingScalingReport
```
public WorkerMessage setStreamingScalingReport(StreamingScalingReport streamingScalingReport)
```
    Contains per-user worker telemetry used in streaming autoscaling.
    
    Parameters:
    
    streamingScalingReport - streamingScalingReport or null for none
  - getTime
```
public String getTime()
```
    The timestamp of the worker_message.
    
    Returns:
    
    value or null for none
  - setTime
```
public WorkerMessage setTime(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
  - getWorkerThreadScalingReport
```
public WorkerThreadScalingReport getWorkerThreadScalingReport()
```
    Thread scaling information reported by workers.
    
    Returns:
    
    value or null for none
  - setWorkerThreadScalingReport
```
public WorkerMessage setWorkerThreadScalingReport(WorkerThreadScalingReport workerThreadScalingReport)
```
    Thread scaling information reported by workers.
    
    Parameters:
    
    workerThreadScalingReport - workerThreadScalingReport or null for none
  - set
```
public WorkerMessage set(String fieldName,
                         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

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

Methods inherited from interface java.util.Map

Constructor Detail

WorkerMessage

Method Detail

getDataSamplingReport

setDataSamplingReport

getLabels

setLabels

getPerWorkerMetrics

setPerWorkerMetrics

getStreamingScalingReport

setStreamingScalingReport

getTime

setTime

getWorkerHealthReport

setWorkerHealthReport

getWorkerLifecycleEvent

setWorkerLifecycleEvent

getWorkerMessageCode

setWorkerMessageCode

getWorkerMetrics

setWorkerMetrics

getWorkerShutdownNotice

setWorkerShutdownNotice

getWorkerThreadScalingReport

setWorkerThreadScalingReport

set

clone