dataflow  v1b3
Public Member Functions | Static Public Member Functions | List of all members
google_dataflow_api::DistributionUpdate Class Reference

#include <distribution_update.h>

Inheritance diagram for google_dataflow_api::DistributionUpdate:

Public Member Functions

 DistributionUpdate (const Json::Value &storage)
 
 DistributionUpdate (Json::Value *storage)
 
virtual ~DistributionUpdate ()
 
const StringPiece GetTypeName () const
 
bool has_count () const
 
void clear_count ()
 
const SplitInt64 get_count () const
 
SplitInt64 mutable_count ()
 
bool has_histogram () const
 
void clear_histogram ()
 
const Histogram get_histogram () const
 
Histogram mutable_histogram ()
 
bool has_max () const
 
void clear_max ()
 
const SplitInt64 get_max () const
 
SplitInt64 mutable_max ()
 
bool has_min () const
 
void clear_min ()
 
const SplitInt64 get_min () const
 
SplitInt64 mutable_min ()
 
bool has_sum () const
 
void clear_sum ()
 
const SplitInt64 get_sum () const
 
SplitInt64 mutable_sum ()
 
bool has_sum_of_squares () const
 
void clear_sum_of_squares ()
 
double get_sum_of_squares () const
 
void set_sum_of_squares (double value)
 

Static Public Member Functions

static DistributionUpdateNew ()
 

Detailed Description

A metric value representing a distribution.

Constructor & Destructor Documentation

◆ DistributionUpdate() [1/2]

google_dataflow_api::DistributionUpdate::DistributionUpdate ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ DistributionUpdate() [2/2]

google_dataflow_api::DistributionUpdate::DistributionUpdate ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~DistributionUpdate()

google_dataflow_api::DistributionUpdate::~DistributionUpdate ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_count()

void google_dataflow_api::DistributionUpdate::clear_count ( )
inline

Clears the 'count' attribute.

◆ clear_histogram()

void google_dataflow_api::DistributionUpdate::clear_histogram ( )
inline

Clears the 'histogram' attribute.

◆ clear_max()

void google_dataflow_api::DistributionUpdate::clear_max ( )
inline

Clears the 'max' attribute.

◆ clear_min()

void google_dataflow_api::DistributionUpdate::clear_min ( )
inline

Clears the 'min' attribute.

◆ clear_sum()

void google_dataflow_api::DistributionUpdate::clear_sum ( )
inline

Clears the 'sum' attribute.

◆ clear_sum_of_squares()

void google_dataflow_api::DistributionUpdate::clear_sum_of_squares ( )
inline

Clears the 'sumOfSquares' attribute.

◆ get_count()

const SplitInt64 google_dataflow_api::DistributionUpdate::get_count ( ) const

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

◆ get_histogram()

const Histogram google_dataflow_api::DistributionUpdate::get_histogram ( ) const

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

◆ get_max()

const SplitInt64 google_dataflow_api::DistributionUpdate::get_max ( ) const

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

◆ get_min()

const SplitInt64 google_dataflow_api::DistributionUpdate::get_min ( ) const

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

◆ get_sum()

const SplitInt64 google_dataflow_api::DistributionUpdate::get_sum ( ) const

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

◆ get_sum_of_squares()

double google_dataflow_api::DistributionUpdate::get_sum_of_squares ( ) const
inline

Get the value of the 'sumOfSquares' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::DistributionUpdate::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::DistributionUpdate

◆ has_count()

bool google_dataflow_api::DistributionUpdate::has_count ( ) const
inline

Determine if the 'count' attribute was set.

Returns
true if the 'count' attribute was set.

◆ has_histogram()

bool google_dataflow_api::DistributionUpdate::has_histogram ( ) const
inline

Determine if the 'histogram' attribute was set.

Returns
true if the 'histogram' attribute was set.

◆ has_max()

bool google_dataflow_api::DistributionUpdate::has_max ( ) const
inline

Determine if the 'max' attribute was set.

Returns
true if the 'max' attribute was set.

◆ has_min()

bool google_dataflow_api::DistributionUpdate::has_min ( ) const
inline

Determine if the 'min' attribute was set.

Returns
true if the 'min' attribute was set.

◆ has_sum()

bool google_dataflow_api::DistributionUpdate::has_sum ( ) const
inline

Determine if the 'sum' attribute was set.

Returns
true if the 'sum' attribute was set.

◆ has_sum_of_squares()

bool google_dataflow_api::DistributionUpdate::has_sum_of_squares ( ) const
inline

Determine if the 'sumOfSquares' attribute was set.

Returns
true if the 'sumOfSquares' attribute was set.

◆ mutable_count()

SplitInt64 google_dataflow_api::DistributionUpdate::mutable_count ( )

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

The count of the number of elements present in the distribution.

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

◆ mutable_histogram()

Histogram google_dataflow_api::DistributionUpdate::mutable_histogram ( )

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

(Optional) Histogram of value counts for the distribution.

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

◆ mutable_max()

SplitInt64 google_dataflow_api::DistributionUpdate::mutable_max ( )

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

The maximum value present in the distribution.

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

◆ mutable_min()

SplitInt64 google_dataflow_api::DistributionUpdate::mutable_min ( )

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

The minimum value present in the distribution.

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

◆ mutable_sum()

SplitInt64 google_dataflow_api::DistributionUpdate::mutable_sum ( )

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

Use an int64 since we'd prefer the added precision. If overflow is a common problem we can detect it and use an additional int64 or a double.

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

◆ New()

DistributionUpdate * google_dataflow_api::DistributionUpdate::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_sum_of_squares()

void google_dataflow_api::DistributionUpdate::set_sum_of_squares ( double  value)
inline

Change the 'sumOfSquares' attribute.

Use a double since the sum of squares is likely to overflow int64.

Parameters
[in]valueThe new value.

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