google_dataflow_api::MetricStructuredName Class Reference

#include <metric_structured_name.h>

Inheritance diagram for google_dataflow_api::MetricStructuredName:

Public Member Functions
	MetricStructuredName (const Json::Value &storage)
	MetricStructuredName (Json::Value *storage)
virtual	~MetricStructuredName ()
const StringPiece	GetTypeName () const
bool	has_context () const
void	clear_context ()
const client::JsonCppAssociativeArray< string >	get_context () const
client::JsonCppAssociativeArray< string >	mutable_context ()
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)
bool	has_origin () const
void	clear_origin ()
const StringPiece	get_origin () const
void	set_origin (const StringPiece &value)

Static Public Member Functions
static MetricStructuredName *	New ()

Detailed Description

Identifies a metric, by describing the source which generated the metric.

Constructor & Destructor Documentation

MetricStructuredName() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

MetricStructuredName() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~MetricStructuredName()

google_dataflow_api::MetricStructuredName::~MetricStructuredName ( )

virtual

Standard destructor.

Member Function Documentation

clear_context()

void google_dataflow_api::MetricStructuredName::clear_context ( )

inline

Clears the 'context' attribute.

clear_name()

void google_dataflow_api::MetricStructuredName::clear_name ( )

inline

Clears the 'name' attribute.

clear_origin()

void google_dataflow_api::MetricStructuredName::clear_origin ( )

inline

Clears the 'origin' attribute.

get_context()

const client::JsonCppAssociativeArray<string > google_dataflow_api::MetricStructuredName::get_context ( ) const

inline

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

get_name()

const StringPiece google_dataflow_api::MetricStructuredName::get_name ( ) const

inline

Get the value of the 'name' attribute.

get_origin()

const StringPiece google_dataflow_api::MetricStructuredName::get_origin ( ) const

inline

Get the value of the 'origin' attribute.

GetTypeName()

const StringPiece google_dataflow_api::MetricStructuredName::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::MetricStructuredName

has_context()

bool google_dataflow_api::MetricStructuredName::has_context ( ) const

inline

Determine if the 'context' attribute was set.

Returns

true if the 'context' attribute was set.

has_name()

bool google_dataflow_api::MetricStructuredName::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

has_origin()

bool google_dataflow_api::MetricStructuredName::has_origin ( ) const

inline

Determine if the 'origin' attribute was set.

Returns

true if the 'origin' attribute was set.

mutable_context()

client::JsonCppAssociativeArray<string > google_dataflow_api::MetricStructuredName::mutable_context ( )

inline

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

Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection.

For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] = .

Returns

The result can be modified to change the attribute value.

New()

MetricStructuredName * google_dataflow_api::MetricStructuredName::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_name()

void google_dataflow_api::MetricStructuredName::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

Worker-defined metric name.

Parameters

[in]

value

The new value.

set_origin()

void google_dataflow_api::MetricStructuredName::set_origin ( const StringPiece &  value )

inline

Change the 'origin' attribute.

Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/metric_structured_name.h
• google/dataflow_api/metric_structured_name.cc