google_dataflow_api::StructuredMessage Class Reference

#include <structured_message.h>

Inheritance diagram for google_dataflow_api::StructuredMessage:

Public Member Functions
	StructuredMessage (const Json::Value &storage)
	StructuredMessage (Json::Value *storage)
virtual	~StructuredMessage ()
const StringPiece	GetTypeName () const
bool	has_message_key () const
void	clear_message_key ()
const StringPiece	get_message_key () const
void	set_message_key (const StringPiece &value)
bool	has_message_text () const
void	clear_message_text ()
const StringPiece	get_message_text () const
void	set_message_text (const StringPiece &value)
bool	has_parameters () const
void	clear_parameters ()
const client::JsonCppArray< Parameter >	get_parameters () const
client::JsonCppArray< Parameter >	mutable_parameters ()

Static Public Member Functions
static StructuredMessage *	New ()

Detailed Description

A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption.

Constructor & Destructor Documentation

StructuredMessage() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

StructuredMessage() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~StructuredMessage()

google_dataflow_api::StructuredMessage::~StructuredMessage ( )

virtual

Standard destructor.

Member Function Documentation

clear_message_key()

void google_dataflow_api::StructuredMessage::clear_message_key ( )

inline

Clears the 'messageKey' attribute.

clear_message_text()

void google_dataflow_api::StructuredMessage::clear_message_text ( )

inline

Clears the 'messageText' attribute.

clear_parameters()

void google_dataflow_api::StructuredMessage::clear_parameters ( )

inline

Clears the 'parameters' attribute.

get_message_key()

const StringPiece google_dataflow_api::StructuredMessage::get_message_key ( ) const

inline

Get the value of the 'messageKey' attribute.

get_message_text()

const StringPiece google_dataflow_api::StructuredMessage::get_message_text ( ) const

inline

Get the value of the 'messageText' attribute.

get_parameters()

const client::JsonCppArray<Parameter > google_dataflow_api::StructuredMessage::get_parameters

(

)

const

Get a reference to the value of the 'parameters' attribute.

GetTypeName()

const StringPiece google_dataflow_api::StructuredMessage::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::StructuredMessage

has_message_key()

bool google_dataflow_api::StructuredMessage::has_message_key ( ) const

inline

Determine if the 'messageKey' attribute was set.

Returns

true if the 'messageKey' attribute was set.

has_message_text()

bool google_dataflow_api::StructuredMessage::has_message_text ( ) const

inline

Determine if the 'messageText' attribute was set.

Returns

true if the 'messageText' attribute was set.

has_parameters()

bool google_dataflow_api::StructuredMessage::has_parameters ( ) const

inline

Determine if the 'parameters' attribute was set.

Returns

true if the 'parameters' attribute was set.

mutable_parameters()

client::JsonCppArray<Parameter > google_dataflow_api::StructuredMessage::mutable_parameters

(

)

Gets a reference to a mutable value of the 'parameters' property.

The structured data associated with this message.

Returns

The result can be modified to change the attribute value.

New()

StructuredMessage * google_dataflow_api::StructuredMessage::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_message_key()

void google_dataflow_api::StructuredMessage::set_message_key ( const StringPiece &  value )

inline

Change the 'messageKey' attribute.

Identifier for this message type. Used by external systems to internationalize or personalize message.

Parameters

[in]

value

The new value.

set_message_text()

void google_dataflow_api::StructuredMessage::set_message_text ( const StringPiece &  value )

inline

Change the 'messageText' attribute.

Human-readable version of message.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/structured_message.h
• google/dataflow_api/structured_message.cc