google_dataflow_api::JobMetrics Class Reference

#include <job_metrics.h>

Inheritance diagram for google_dataflow_api::JobMetrics:

Public Member Functions
	JobMetrics (const Json::Value &storage)
	JobMetrics (Json::Value *storage)
virtual	~JobMetrics ()
const StringPiece	GetTypeName () const
bool	has_metric_time () const
void	clear_metric_time ()
const StringPiece	get_metric_time () const
void	set_metric_time (const StringPiece &value)
bool	has_metrics () const
void	clear_metrics ()
const client::JsonCppArray< MetricUpdate >	get_metrics () const
client::JsonCppArray< MetricUpdate >	mutable_metrics ()

Static Public Member Functions
static JobMetrics *	New ()

Detailed Description

JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job.

This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.

Constructor & Destructor Documentation

JobMetrics() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

JobMetrics() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~JobMetrics()

google_dataflow_api::JobMetrics::~JobMetrics ( )

virtual

Standard destructor.

Member Function Documentation

clear_metric_time()

void google_dataflow_api::JobMetrics::clear_metric_time ( )

inline

Clears the 'metricTime' attribute.

clear_metrics()

void google_dataflow_api::JobMetrics::clear_metrics ( )

inline

Clears the 'metrics' attribute.

get_metric_time()

const StringPiece google_dataflow_api::JobMetrics::get_metric_time ( ) const

inline

Get the value of the 'metricTime' attribute.

get_metrics()

const client::JsonCppArray<MetricUpdate > google_dataflow_api::JobMetrics::get_metrics

(

)

const

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

GetTypeName()

const StringPiece google_dataflow_api::JobMetrics::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::JobMetrics

has_metric_time()

bool google_dataflow_api::JobMetrics::has_metric_time ( ) const

inline

Determine if the 'metricTime' attribute was set.

Returns

true if the 'metricTime' attribute was set.

has_metrics()

bool google_dataflow_api::JobMetrics::has_metrics ( ) const

inline

Determine if the 'metrics' attribute was set.

Returns

true if the 'metrics' attribute was set.

mutable_metrics()

client::JsonCppArray<MetricUpdate > google_dataflow_api::JobMetrics::mutable_metrics

(

)

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

All metrics for this job.

Returns

The result can be modified to change the attribute value.

New()

JobMetrics * google_dataflow_api::JobMetrics::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_metric_time()

void google_dataflow_api::JobMetrics::set_metric_time ( const StringPiece &  value )

inline

Change the 'metricTime' attribute.

Timestamp as of which metric values are current.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/job_metrics.h
• google/dataflow_api/job_metrics.cc