google_dataflow_api::HotKeyDetection Class Reference

#include <hot_key_detection.h>

Inheritance diagram for google_dataflow_api::HotKeyDetection:

Public Member Functions
	HotKeyDetection (const Json::Value &storage)
	HotKeyDetection (Json::Value *storage)
virtual	~HotKeyDetection ()
const StringPiece	GetTypeName () const
bool	has_hot_key_age () const
void	clear_hot_key_age ()
const StringPiece	get_hot_key_age () const
void	set_hot_key_age (const StringPiece &value)
bool	has_system_name () const
void	clear_system_name ()
const StringPiece	get_system_name () const
void	set_system_name (const StringPiece &value)
bool	has_user_step_name () const
void	clear_user_step_name ()
const StringPiece	get_user_step_name () const
void	set_user_step_name (const StringPiece &value)

Static Public Member Functions
static HotKeyDetection *	New ()

Detailed Description

Proto describing a hot key detected on a given WorkItem.

Constructor & Destructor Documentation

HotKeyDetection() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

HotKeyDetection() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~HotKeyDetection()

google_dataflow_api::HotKeyDetection::~HotKeyDetection ( )

virtual

Standard destructor.

Member Function Documentation

clear_hot_key_age()

void google_dataflow_api::HotKeyDetection::clear_hot_key_age ( )

inline

Clears the 'hotKeyAge' attribute.

clear_system_name()

void google_dataflow_api::HotKeyDetection::clear_system_name ( )

inline

Clears the 'systemName' attribute.

clear_user_step_name()

void google_dataflow_api::HotKeyDetection::clear_user_step_name ( )

inline

Clears the 'userStepName' attribute.

get_hot_key_age()

const StringPiece google_dataflow_api::HotKeyDetection::get_hot_key_age ( ) const

inline

Get the value of the 'hotKeyAge' attribute.

get_system_name()

const StringPiece google_dataflow_api::HotKeyDetection::get_system_name ( ) const

inline

Get the value of the 'systemName' attribute.

get_user_step_name()

const StringPiece google_dataflow_api::HotKeyDetection::get_user_step_name ( ) const

inline

Get the value of the 'userStepName' attribute.

GetTypeName()

const StringPiece google_dataflow_api::HotKeyDetection::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::HotKeyDetection

has_hot_key_age()

bool google_dataflow_api::HotKeyDetection::has_hot_key_age ( ) const

inline

Determine if the 'hotKeyAge' attribute was set.

Returns

true if the 'hotKeyAge' attribute was set.

has_system_name()

bool google_dataflow_api::HotKeyDetection::has_system_name ( ) const

inline

Determine if the 'systemName' attribute was set.

Returns

true if the 'systemName' attribute was set.

has_user_step_name()

bool google_dataflow_api::HotKeyDetection::has_user_step_name ( ) const

inline

Determine if the 'userStepName' attribute was set.

Returns

true if the 'userStepName' attribute was set.

New()

HotKeyDetection * google_dataflow_api::HotKeyDetection::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_hot_key_age()

void google_dataflow_api::HotKeyDetection::set_hot_key_age ( const StringPiece &  value )

inline

Change the 'hotKeyAge' attribute.

The age of the hot key measured from when it was first detected.

Parameters

[in]

value

The new value.

set_system_name()

void google_dataflow_api::HotKeyDetection::set_system_name ( const StringPiece &  value )

inline

Change the 'systemName' attribute.

System-defined name of the step containing this hot key. Unique across the workflow.

Parameters

[in]

value

The new value.

set_user_step_name()

void google_dataflow_api::HotKeyDetection::set_user_step_name ( const StringPiece &  value )

inline

Change the 'userStepName' attribute.

User-provided name of the step that contains this hot key.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/hot_key_detection.h
• google/dataflow_api/hot_key_detection.cc