#include <metric_update.h>

Inheritance diagram for google_dataflow_api::MetricUpdate:

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

	MetricUpdate (Json::Value *storage)

virtual	~MetricUpdate ()

const StringPiece	GetTypeName () const

bool	has_cumulative () const

void	clear_cumulative ()

bool	get_cumulative () const

void	set_cumulative (bool value)

bool	has_distribution () const

void	clear_distribution ()

const client::JsonCppData	get_distribution () const

client::JsonCppData	mutable_distribution ()

bool	has_gauge () const

void	clear_gauge ()

const client::JsonCppData	get_gauge () const

client::JsonCppData	mutable_gauge ()

bool	has_internal () const

void	clear_internal ()

const client::JsonCppData	get_internal () const

client::JsonCppData	mutable_internal ()

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_mean_count () const

void	clear_mean_count ()

const client::JsonCppData	get_mean_count () const

client::JsonCppData	mutable_meanCount ()

bool	has_mean_sum () const

void	clear_mean_sum ()

const client::JsonCppData	get_mean_sum () const

client::JsonCppData	mutable_meanSum ()

bool	has_name () const

void	clear_name ()

const MetricStructuredName	get_name () const

MetricStructuredName	mutable_name ()

bool	has_scalar () const

void	clear_scalar ()

const client::JsonCppData	get_scalar () const

client::JsonCppData	mutable_scalar ()

bool	has_set () const

void	clear_set ()

const client::JsonCppData	get_set () const

client::JsonCppData	mutable_set ()

bool	has_update_time () const

void	clear_update_time ()

const StringPiece	get_update_time () const

void	set_update_time (const StringPiece &value)

Static Public Member Functions
static MetricUpdate *	New ()

Detailed Description

Describes the state of a metric.

Constructor & Destructor Documentation

◆ MetricUpdate() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ MetricUpdate() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~MetricUpdate()

google_dataflow_api::MetricUpdate::~MetricUpdate ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_cumulative()

void google_dataflow_api::MetricUpdate::clear_cumulative ( )

inline

Clears the 'cumulative' attribute.

◆ clear_distribution()

void google_dataflow_api::MetricUpdate::clear_distribution ( )

inline

Clears the 'distribution' attribute.

◆ clear_gauge()

void google_dataflow_api::MetricUpdate::clear_gauge ( )

inline

Clears the 'gauge' attribute.

◆ clear_internal()

void google_dataflow_api::MetricUpdate::clear_internal ( )

inline

Clears the 'internal' attribute.

◆ clear_kind()

void google_dataflow_api::MetricUpdate::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_mean_count()

void google_dataflow_api::MetricUpdate::clear_mean_count ( )

inline

Clears the 'meanCount' attribute.

◆ clear_mean_sum()

void google_dataflow_api::MetricUpdate::clear_mean_sum ( )

inline

Clears the 'meanSum' attribute.

◆ clear_name()

void google_dataflow_api::MetricUpdate::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_scalar()

void google_dataflow_api::MetricUpdate::clear_scalar ( )

inline

Clears the 'scalar' attribute.

◆ clear_set()

void google_dataflow_api::MetricUpdate::clear_set ( )

inline

Clears the 'set' attribute.

◆ clear_update_time()

void google_dataflow_api::MetricUpdate::clear_update_time ( )

inline

Clears the 'updateTime' attribute.

◆ get_cumulative()

bool google_dataflow_api::MetricUpdate::get_cumulative ( ) const

inline

Get the value of the 'cumulative' attribute.

◆ get_distribution()

const client::JsonCppData google_dataflow_api::MetricUpdate::get_distribution ( ) const

inline

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

◆ get_gauge()

const client::JsonCppData google_dataflow_api::MetricUpdate::get_gauge ( ) const

inline

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

◆ get_internal()

const client::JsonCppData google_dataflow_api::MetricUpdate::get_internal ( ) const

inline

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

◆ get_kind()

const StringPiece google_dataflow_api::MetricUpdate::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_mean_count()

const client::JsonCppData google_dataflow_api::MetricUpdate::get_mean_count ( ) const

inline

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

◆ get_mean_sum()

const client::JsonCppData google_dataflow_api::MetricUpdate::get_mean_sum ( ) const

inline

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

◆ get_name()

const MetricStructuredName google_dataflow_api::MetricUpdate::get_name ( ) const

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

◆ get_scalar()

const client::JsonCppData google_dataflow_api::MetricUpdate::get_scalar ( ) const

inline

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

◆ get_set()

const client::JsonCppData google_dataflow_api::MetricUpdate::get_set ( ) const

inline

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

◆ get_update_time()

const StringPiece google_dataflow_api::MetricUpdate::get_update_time ( ) const

inline

Get the value of the 'updateTime' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::MetricUpdate::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::MetricUpdate

◆ has_cumulative()

bool google_dataflow_api::MetricUpdate::has_cumulative ( ) const

inline

Determine if the 'cumulative' attribute was set.

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

◆ has_distribution()

bool google_dataflow_api::MetricUpdate::has_distribution ( ) const

inline

Determine if the 'distribution' attribute was set.

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

◆ has_gauge()

bool google_dataflow_api::MetricUpdate::has_gauge ( ) const

inline

Determine if the 'gauge' attribute was set.

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

◆ has_internal()

bool google_dataflow_api::MetricUpdate::has_internal ( ) const

inline

Determine if the 'internal' attribute was set.

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

◆ has_kind()

bool google_dataflow_api::MetricUpdate::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

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

◆ has_mean_count()

bool google_dataflow_api::MetricUpdate::has_mean_count ( ) const

inline

Determine if the 'meanCount' attribute was set.

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

◆ has_mean_sum()

bool google_dataflow_api::MetricUpdate::has_mean_sum ( ) const

inline

Determine if the 'meanSum' attribute was set.

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

◆ has_name()

bool google_dataflow_api::MetricUpdate::has_name ( ) const

inline

Determine if the 'name' attribute was set.

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

◆ has_scalar()

bool google_dataflow_api::MetricUpdate::has_scalar ( ) const

inline

Determine if the 'scalar' attribute was set.

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

◆ has_set()

bool google_dataflow_api::MetricUpdate::has_set ( ) const

inline

Determine if the 'set' attribute was set.

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

◆ has_update_time()

bool google_dataflow_api::MetricUpdate::has_update_time ( ) const

inline

Determine if the 'updateTime' attribute was set.

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

◆ mutable_distribution()

client::JsonCppData google_dataflow_api::MetricUpdate::mutable_distribution ( )

inline

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

A struct value describing properties of a distribution of numeric values.

Returns: The result can be modified to change the attribute value.

◆ mutable_gauge()

client::JsonCppData google_dataflow_api::MetricUpdate::mutable_gauge ( )

inline

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

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

Returns: The result can be modified to change the attribute value.

◆ mutable_internal()

client::JsonCppData google_dataflow_api::MetricUpdate::mutable_internal ( )

inline

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

Worker-computed aggregate value for internal use by the Dataflow service.

Returns: The result can be modified to change the attribute value.

◆ mutable_meanCount()

client::JsonCppData google_dataflow_api::MetricUpdate::mutable_meanCount ( )

inline

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

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

Returns: The result can be modified to change the attribute value.

◆ mutable_meanSum()

client::JsonCppData google_dataflow_api::MetricUpdate::mutable_meanSum ( )

inline

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

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

Returns: The result can be modified to change the attribute value.

◆ mutable_name()

MetricStructuredName google_dataflow_api::MetricUpdate::mutable_name ( )

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

Name of the metric.

Returns: The result can be modified to change the attribute value.

◆ mutable_scalar()

client::JsonCppData google_dataflow_api::MetricUpdate::mutable_scalar ( )

inline

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

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

Returns: The result can be modified to change the attribute value.

◆ mutable_set()

client::JsonCppData google_dataflow_api::MetricUpdate::mutable_set ( )

inline

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

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

Returns: The result can be modified to change the attribute value.

◆ New()

MetricUpdate * google_dataflow_api::MetricUpdate::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_cumulative()

void google_dataflow_api::MetricUpdate::set_cumulative ( bool value )

inline

Change the 'cumulative' attribute.

True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.

Parameters

[in] value The new value.

◆ set_kind()

void google_dataflow_api::MetricUpdate::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive.

If omitted, this is not an aggregated value but instead a single metric sample value.

Parameters

[in] value The new value.

◆ set_update_time()

void google_dataflow_api::MetricUpdate::set_update_time ( const StringPiece & value )

inline

Change the 'updateTime' attribute.

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

Parameters

[in] value The new value.

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

google/dataflow_api/metric_update.h
google/dataflow_api/metric_update.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MetricUpdate() [1/2]

◆ MetricUpdate() [2/2]

◆ ~MetricUpdate()

Member Function Documentation

◆ clear_cumulative()

◆ clear_distribution()

◆ clear_gauge()

◆ clear_internal()

◆ clear_kind()

◆ clear_mean_count()

◆ clear_mean_sum()

◆ clear_name()

◆ clear_scalar()

◆ clear_set()

◆ clear_update_time()

◆ get_cumulative()

◆ get_distribution()

◆ get_gauge()

◆ get_internal()

◆ get_kind()

◆ get_mean_count()

◆ get_mean_sum()

◆ get_name()

◆ get_scalar()

◆ get_set()

◆ get_update_time()

◆ GetTypeName()

◆ has_cumulative()

◆ has_distribution()

◆ has_gauge()

◆ has_internal()

◆ has_kind()

◆ has_mean_count()

◆ has_mean_sum()

◆ has_name()

◆ has_scalar()

◆ has_set()

◆ has_update_time()

◆ mutable_distribution()

◆ mutable_gauge()

◆ mutable_internal()

◆ mutable_meanCount()

◆ mutable_meanSum()

◆ mutable_name()

◆ mutable_scalar()

◆ mutable_set()

◆ New()

◆ set_cumulative()

◆ set_kind()

◆ set_update_time()