#include <display_data.h>

Inheritance diagram for google_dataflow_api::DisplayData:

Public Member Functions
	DisplayData (const Json::Value &storage)

	DisplayData (Json::Value *storage)

virtual	~DisplayData ()

const StringPiece	GetTypeName () const

bool	has_bool_value () const

void	clear_bool_value ()

bool	get_bool_value () const

void	set_bool_value (bool value)

bool	has_duration_value () const

void	clear_duration_value ()

const StringPiece	get_duration_value () const

void	set_duration_value (const StringPiece &value)

bool	has_float_value () const

void	clear_float_value ()

float	get_float_value () const

void	set_float_value (float value)

bool	has_int64_value () const

void	clear_int64_value ()

int64	get_int64_value () const

void	set_int64_value (int64 value)

bool	has_java_class_value () const

void	clear_java_class_value ()

const StringPiece	get_java_class_value () const

void	set_java_class_value (const StringPiece &value)

bool	has_key () const

void	clear_key ()

const StringPiece	get_key () const

void	set_key (const StringPiece &value)

bool	has_label () const

void	clear_label ()

const StringPiece	get_label () const

void	set_label (const StringPiece &value)

bool	has_namespace () const

void	clear_namespace ()

const StringPiece	get_namespace () const

void	set_namespace (const StringPiece &value)

bool	has_short_str_value () const

void	clear_short_str_value ()

const StringPiece	get_short_str_value () const

void	set_short_str_value (const StringPiece &value)

bool	has_str_value () const

void	clear_str_value ()

const StringPiece	get_str_value () const

void	set_str_value (const StringPiece &value)

bool	has_timestamp_value () const

void	clear_timestamp_value ()

const StringPiece	get_timestamp_value () const

void	set_timestamp_value (const StringPiece &value)

bool	has_url () const

void	clear_url ()

const StringPiece	get_url () const

void	set_url (const StringPiece &value)

Static Public Member Functions
static DisplayData *	New ()

Detailed Description

Data provided with a pipeline or transform to provide descriptive info.

Constructor & Destructor Documentation

◆ DisplayData() [1/2]

google_dataflow_api::DisplayData::DisplayData ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ DisplayData() [2/2]

google_dataflow_api::DisplayData::DisplayData ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~DisplayData()

google_dataflow_api::DisplayData::~DisplayData ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_bool_value()

void google_dataflow_api::DisplayData::clear_bool_value ( )

inline

Clears the 'boolValue' attribute.

◆ clear_duration_value()

void google_dataflow_api::DisplayData::clear_duration_value ( )

inline

Clears the 'durationValue' attribute.

◆ clear_float_value()

void google_dataflow_api::DisplayData::clear_float_value ( )

inline

Clears the 'floatValue' attribute.

◆ clear_int64_value()

void google_dataflow_api::DisplayData::clear_int64_value ( )

inline

Clears the 'int64Value' attribute.

◆ clear_java_class_value()

void google_dataflow_api::DisplayData::clear_java_class_value ( )

inline

Clears the 'javaClassValue' attribute.

◆ clear_key()

void google_dataflow_api::DisplayData::clear_key ( )

inline

Clears the 'key' attribute.

◆ clear_label()

void google_dataflow_api::DisplayData::clear_label ( )

inline

Clears the 'label' attribute.

◆ clear_namespace()

void google_dataflow_api::DisplayData::clear_namespace ( )

inline

Clears the 'namespace' attribute.

◆ clear_short_str_value()

void google_dataflow_api::DisplayData::clear_short_str_value ( )

inline

Clears the 'shortStrValue' attribute.

◆ clear_str_value()

void google_dataflow_api::DisplayData::clear_str_value ( )

inline

Clears the 'strValue' attribute.

◆ clear_timestamp_value()

void google_dataflow_api::DisplayData::clear_timestamp_value ( )

inline

Clears the 'timestampValue' attribute.

◆ clear_url()

void google_dataflow_api::DisplayData::clear_url ( )

inline

Clears the 'url' attribute.

◆ get_bool_value()

bool google_dataflow_api::DisplayData::get_bool_value ( ) const

inline

Get the value of the 'boolValue' attribute.

◆ get_duration_value()

const StringPiece google_dataflow_api::DisplayData::get_duration_value ( ) const

inline

Get the value of the 'durationValue' attribute.

◆ get_float_value()

float google_dataflow_api::DisplayData::get_float_value ( ) const

inline

Get the value of the 'floatValue' attribute.

◆ get_int64_value()

int64 google_dataflow_api::DisplayData::get_int64_value ( ) const

inline

Get the value of the 'int64Value' attribute.

◆ get_java_class_value()

const StringPiece google_dataflow_api::DisplayData::get_java_class_value ( ) const

inline

Get the value of the 'javaClassValue' attribute.

◆ get_key()

const StringPiece google_dataflow_api::DisplayData::get_key ( ) const

inline

Get the value of the 'key' attribute.

◆ get_label()

const StringPiece google_dataflow_api::DisplayData::get_label ( ) const

inline

Get the value of the 'label' attribute.

◆ get_namespace()

const StringPiece google_dataflow_api::DisplayData::get_namespace ( ) const

inline

Get the value of the 'namespace' attribute.

◆ get_short_str_value()

const StringPiece google_dataflow_api::DisplayData::get_short_str_value ( ) const

inline

Get the value of the 'shortStrValue' attribute.

◆ get_str_value()

const StringPiece google_dataflow_api::DisplayData::get_str_value ( ) const

inline

Get the value of the 'strValue' attribute.

◆ get_timestamp_value()

const StringPiece google_dataflow_api::DisplayData::get_timestamp_value ( ) const

inline

Get the value of the 'timestampValue' attribute.

◆ get_url()

const StringPiece google_dataflow_api::DisplayData::get_url ( ) const

inline

Get the value of the 'url' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::DisplayData::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::DisplayData

◆ has_bool_value()

bool google_dataflow_api::DisplayData::has_bool_value ( ) const

inline

Determine if the 'boolValue' attribute was set.

Returns: true if the 'boolValue' attribute was set.

◆ has_duration_value()

bool google_dataflow_api::DisplayData::has_duration_value ( ) const

inline

Determine if the 'durationValue' attribute was set.

Returns: true if the 'durationValue' attribute was set.

◆ has_float_value()

bool google_dataflow_api::DisplayData::has_float_value ( ) const

inline

Determine if the 'floatValue' attribute was set.

Returns: true if the 'floatValue' attribute was set.

◆ has_int64_value()

bool google_dataflow_api::DisplayData::has_int64_value ( ) const

inline

Determine if the 'int64Value' attribute was set.

Returns: true if the 'int64Value' attribute was set.

◆ has_java_class_value()

bool google_dataflow_api::DisplayData::has_java_class_value ( ) const

inline

Determine if the 'javaClassValue' attribute was set.

Returns: true if the 'javaClassValue' attribute was set.

◆ has_key()

bool google_dataflow_api::DisplayData::has_key ( ) const

inline

Determine if the 'key' attribute was set.

Returns: true if the 'key' attribute was set.

◆ has_label()

bool google_dataflow_api::DisplayData::has_label ( ) const

inline

Determine if the 'label' attribute was set.

Returns: true if the 'label' attribute was set.

◆ has_namespace()

bool google_dataflow_api::DisplayData::has_namespace ( ) const

inline

Determine if the 'namespace' attribute was set.

Returns: true if the 'namespace' attribute was set.

◆ has_short_str_value()

bool google_dataflow_api::DisplayData::has_short_str_value ( ) const

inline

Determine if the 'shortStrValue' attribute was set.

Returns: true if the 'shortStrValue' attribute was set.

◆ has_str_value()

bool google_dataflow_api::DisplayData::has_str_value ( ) const

inline

Determine if the 'strValue' attribute was set.

Returns: true if the 'strValue' attribute was set.

◆ has_timestamp_value()

bool google_dataflow_api::DisplayData::has_timestamp_value ( ) const

inline

Determine if the 'timestampValue' attribute was set.

Returns: true if the 'timestampValue' attribute was set.

◆ has_url()

bool google_dataflow_api::DisplayData::has_url ( ) const

inline

Determine if the 'url' attribute was set.

Returns: true if the 'url' attribute was set.

◆ New()

DisplayData * google_dataflow_api::DisplayData::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_bool_value()

void google_dataflow_api::DisplayData::set_bool_value ( bool value )

inline

Change the 'boolValue' attribute.

Contains value if the data is of a boolean type.

Parameters

[in] value The new value.

◆ set_duration_value()

void google_dataflow_api::DisplayData::set_duration_value ( const StringPiece & value )

inline

Change the 'durationValue' attribute.

Contains value if the data is of duration type.

Parameters

[in] value The new value.

◆ set_float_value()

void google_dataflow_api::DisplayData::set_float_value ( float value )

inline

Change the 'floatValue' attribute.

Contains value if the data is of float type.

Parameters

[in] value The new value.

◆ set_int64_value()

void google_dataflow_api::DisplayData::set_int64_value ( int64 value )

inline

Change the 'int64Value' attribute.

Contains value if the data is of int64 type.

Parameters

[in] value The new value.

◆ set_java_class_value()

void google_dataflow_api::DisplayData::set_java_class_value ( const StringPiece & value )

inline

Change the 'javaClassValue' attribute.

Contains value if the data is of java class type.

Parameters

[in] value The new value.

◆ set_key()

void google_dataflow_api::DisplayData::set_key ( const StringPiece & value )

inline

Change the 'key' attribute.

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

[in] value The new value.

◆ set_label()

void google_dataflow_api::DisplayData::set_label ( const StringPiece & value )

inline

Change the 'label' attribute.

An optional label to display in a dax UI for the element.

Parameters

[in] value The new value.

◆ set_namespace()

void google_dataflow_api::DisplayData::set_namespace ( const StringPiece & value )

inline

Change the 'namespace' attribute.

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

[in] value The new value.

◆ set_short_str_value()

void google_dataflow_api::DisplayData::set_short_str_value ( const StringPiece & value )

inline

Change the 'shortStrValue' attribute.

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

[in] value The new value.

◆ set_str_value()

void google_dataflow_api::DisplayData::set_str_value ( const StringPiece & value )

inline

Change the 'strValue' attribute.

Contains value if the data is of string type.

Parameters

[in] value The new value.

◆ set_timestamp_value()

void google_dataflow_api::DisplayData::set_timestamp_value ( const StringPiece & value )

inline

Change the 'timestampValue' attribute.

Contains value if the data is of timestamp type.

Parameters

[in] value The new value.

◆ set_url()

void google_dataflow_api::DisplayData::set_url ( const StringPiece & value )

inline

Change the 'url' attribute.

An optional full URL.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/dataflow_api/display_data.h
google/dataflow_api/display_data.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DisplayData() [1/2]

◆ DisplayData() [2/2]

◆ ~DisplayData()

Member Function Documentation

◆ clear_bool_value()

◆ clear_duration_value()

◆ clear_float_value()

◆ clear_int64_value()

◆ clear_java_class_value()

◆ clear_key()

◆ clear_label()

◆ clear_namespace()

◆ clear_short_str_value()

◆ clear_str_value()

◆ clear_timestamp_value()

◆ clear_url()

◆ get_bool_value()

◆ get_duration_value()

◆ get_float_value()

◆ get_int64_value()

◆ get_java_class_value()

◆ get_key()

◆ get_label()

◆ get_namespace()

◆ get_short_str_value()

◆ get_str_value()

◆ get_timestamp_value()

◆ get_url()

◆ GetTypeName()

◆ has_bool_value()

◆ has_duration_value()

◆ has_float_value()

◆ has_int64_value()

◆ has_java_class_value()

◆ has_key()

◆ has_label()

◆ has_namespace()

◆ has_short_str_value()

◆ has_str_value()

◆ has_timestamp_value()

◆ has_url()

◆ New()

◆ set_bool_value()

◆ set_duration_value()

◆ set_float_value()

◆ set_int64_value()

◆ set_java_class_value()

◆ set_key()

◆ set_label()

◆ set_namespace()

◆ set_short_str_value()

◆ set_str_value()

◆ set_timestamp_value()

◆ set_url()