DisplayData (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.DisplayData

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class DisplayData
extends com.google.api.client.json.GenericJson
```
Data provided with a pipeline or transform to provide descriptive info.
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

DisplayData()

Constructors
Constructor and Description
`DisplayData()`

Method Summary

Methods
Modifier and Type	Method and Description
`DisplayData`	`clone()`
`java.lang.Boolean`	`getBoolValue()` Contains value if the data is of a boolean type.
`java.lang.String`	`getDurationValue()` Contains value if the data is of duration type.
`java.lang.Float`	`getFloatValue()` Contains value if the data is of float type.
`java.lang.Long`	`getInt64Value()` Contains value if the data is of int64 type.
`java.lang.String`	`getJavaClassValue()` Contains value if the data is of java class type.
`java.lang.String`	`getKey()` The key identifying the display data.
`java.lang.String`	`getLabel()` An optional label to display in a dax UI for the element.
`java.lang.String`	`getNamespace()` The namespace for the key.
`java.lang.String`	`getShortStrValue()` A possible additional shorter value to display.
`java.lang.String`	`getStrValue()` Contains value if the data is of string type.
`java.lang.String`	`getTimestampValue()` Contains value if the data is of timestamp type.
`java.lang.String`	`getUrl()` An optional full URL.
`DisplayData`	`set(java.lang.String fieldName, java.lang.Object value)`
`DisplayData`	`setBoolValue(java.lang.Boolean boolValue)` Contains value if the data is of a boolean type.
`DisplayData`	`setDurationValue(java.lang.String durationValue)` Contains value if the data is of duration type.
`DisplayData`	`setFloatValue(java.lang.Float floatValue)` Contains value if the data is of float type.
`DisplayData`	`setInt64Value(java.lang.Long int64Value)` Contains value if the data is of int64 type.
`DisplayData`	`setJavaClassValue(java.lang.String javaClassValue)` Contains value if the data is of java class type.
`DisplayData`	`setKey(java.lang.String key)` The key identifying the display data.
`DisplayData`	`setLabel(java.lang.String label)` An optional label to display in a dax UI for the element.
`DisplayData`	`setNamespace(java.lang.String namespace)` The namespace for the key.
`DisplayData`	`setShortStrValue(java.lang.String shortStrValue)` A possible additional shorter value to display.
`DisplayData`	`setStrValue(java.lang.String strValue)` Contains value if the data is of string type.
`DisplayData`	`setTimestampValue(java.lang.String timestampValue)` Contains value if the data is of timestamp type.
`DisplayData`	`setUrl(java.lang.String url)` An optional full URL.

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
  - DisplayData
```
public DisplayData()
```
- Method Detail
  - getBoolValue
```
public java.lang.Boolean getBoolValue()
```
    Contains value if the data is of a boolean type.
    
    Returns:
    value or null for none
  - setBoolValue
```
public DisplayData setBoolValue(java.lang.Boolean boolValue)
```
    Contains value if the data is of a boolean type.
    
    Parameters:
    boolValue - boolValue or null for none
  - getDurationValue
```
public java.lang.String getDurationValue()
```
    Contains value if the data is of duration type.
    
    Returns:
    value or null for none
  - setDurationValue
```
public DisplayData setDurationValue(java.lang.String durationValue)
```
    Contains value if the data is of duration type.
    
    Parameters:
    durationValue - durationValue or null for none
  - getFloatValue
```
public java.lang.Float getFloatValue()
```
    Contains value if the data is of float type.
    
    Returns:
    value or null for none
  - setFloatValue
```
public DisplayData setFloatValue(java.lang.Float floatValue)
```
    Contains value if the data is of float type.
    
    Parameters:
    floatValue - floatValue or null for none
  - getInt64Value
```
public java.lang.Long getInt64Value()
```
    Contains value if the data is of int64 type.
    
    Returns:
    value or null for none
  - setInt64Value
```
public DisplayData setInt64Value(java.lang.Long int64Value)
```
    Contains value if the data is of int64 type.
    
    Parameters:
    int64Value - int64Value or null for none
  - getJavaClassValue
```
public java.lang.String getJavaClassValue()
```
    Contains value if the data is of java class type.
    
    Returns:
    value or null for none
  - setJavaClassValue
```
public DisplayData setJavaClassValue(java.lang.String javaClassValue)
```
    Contains value if the data is of java class type.
    
    Parameters:
    javaClassValue - javaClassValue or null for none
  - getKey
```
public java.lang.String getKey()
```
    The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.
    
    Returns:
    value or null for none
  - setKey
```
public DisplayData setKey(java.lang.String key)
```
    The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.
    
    Parameters:
    key - key or null for none
  - getLabel
```
public java.lang.String getLabel()
```
    An optional label to display in a dax UI for the element.
    
    Returns:
    value or null for none
  - setLabel
```
public DisplayData setLabel(java.lang.String label)
```
    An optional label to display in a dax UI for the element.
    
    Parameters:
    label - label or null for none
  - getNamespace
```
public java.lang.String getNamespace()
```
    The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.
    
    Returns:
    value or null for none
  - setNamespace
```
public DisplayData setNamespace(java.lang.String namespace)
```
    The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.
    
    Parameters:
    namespace - namespace or null for none
  - getShortStrValue
```
public java.lang.String getShortStrValue()
```
    A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.
    
    Returns:
    value or null for none
  - setShortStrValue
```
public DisplayData setShortStrValue(java.lang.String shortStrValue)
```
    A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.
    
    Parameters:
    shortStrValue - shortStrValue or null for none
  - getStrValue
```
public java.lang.String getStrValue()
```
    Contains value if the data is of string type.
    
    Returns:
    value or null for none
  - setStrValue
```
public DisplayData setStrValue(java.lang.String strValue)
```
    Contains value if the data is of string type.
    
    Parameters:
    strValue - strValue or null for none
  - getTimestampValue
```
public java.lang.String getTimestampValue()
```
    Contains value if the data is of timestamp type.
    
    Returns:
    value or null for none
  - setTimestampValue
```
public DisplayData setTimestampValue(java.lang.String timestampValue)
```
    Contains value if the data is of timestamp type.
    
    Parameters:
    timestampValue - timestampValue or null for none
  - getUrl
```
public java.lang.String getUrl()
```
    An optional full URL.
    
    Returns:
    value or null for none
  - setUrl
```
public DisplayData setUrl(java.lang.String url)
```
    An optional full URL.
    
    Parameters:
    url - url or null for none
  - set
```
public DisplayData set(java.lang.String fieldName,
              java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public DisplayData clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Dataflow API v1b3 (revision 237)

Class DisplayData

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

DisplayData

Method Detail

getBoolValue

setBoolValue

getDurationValue

setDurationValue

getFloatValue

setFloatValue

getInt64Value

setInt64Value

getJavaClassValue

setJavaClassValue

getKey

setKey

getLabel

setLabel

getNamespace

setNamespace

getShortStrValue

setShortStrValue

getStrValue

setStrValue

getTimestampValue

setTimestampValue

getUrl

setUrl

set

clone