com.google.api.services.dataflow.model

Class WorkerMessageCode

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

All Implemented Interfaces:

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

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

A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure).

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: http://code.google.com/p/google-http-java-client/wiki/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
WorkerMessageCode()

Method Summary

Methods

Modifier and Type	Method and Description
WorkerMessageCode	clone()
java.lang.String	getCode() The code is a string intended for consumption by a machine that identifies the type of message being sent.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Parameters contains specific information about the code.
WorkerMessageCode	set(java.lang.String fieldName, java.lang.Object value)
WorkerMessageCode	setCode(java.lang.String code) The code is a string intended for consumption by a machine that identifies the type of message being sent.
WorkerMessageCode	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Parameters contains specific information about the code.

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

WorkerMessageCode

public WorkerMessageCode()

Method Detail

getCode

public java.lang.String getCode()

The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a GCS file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change.

Returns:

value or null for none

setCode

public WorkerMessageCode setCode(java.lang.String code)

The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a GCS file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change.

Parameters:

code - code or null for none

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.

Returns:

value or null for none

setParameters

public WorkerMessageCode setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.

Parameters:

parameters - parameters or null for none

set

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

Overrides:

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

clone

public WorkerMessageCode clone()

Overrides:

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