#include <counter_structured_name.h>

Inheritance diagram for google_dataflow_api::CounterStructuredName:

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

	CounterStructuredName (Json::Value *storage)

virtual	~CounterStructuredName ()

const StringPiece	GetTypeName () const

bool	has_component_step_name () const

void	clear_component_step_name ()

const StringPiece	get_component_step_name () const

void	set_component_step_name (const StringPiece &value)

bool	has_execution_step_name () const

void	clear_execution_step_name ()

const StringPiece	get_execution_step_name () const

void	set_execution_step_name (const StringPiece &value)

bool	has_input_index () const

void	clear_input_index ()

int32	get_input_index () const

void	set_input_index (int32 value)

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)

bool	has_origin_namespace () const

void	clear_origin_namespace ()

const StringPiece	get_origin_namespace () const

void	set_origin_namespace (const StringPiece &value)

bool	has_original_requesting_step_name () const

void	clear_original_requesting_step_name ()

const StringPiece	get_original_requesting_step_name () const

void	set_original_requesting_step_name (const StringPiece &value)

bool	has_original_step_name () const

void	clear_original_step_name ()

const StringPiece	get_original_step_name () const

void	set_original_step_name (const StringPiece &value)

bool	has_portion () const

void	clear_portion ()

const StringPiece	get_portion () const

void	set_portion (const StringPiece &value)

bool	has_worker_id () const

void	clear_worker_id ()

const StringPiece	get_worker_id () const

void	set_worker_id (const StringPiece &value)

Static Public Member Functions
static CounterStructuredName *	New ()

Detailed Description

Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job.

Constructor & Destructor Documentation

◆ CounterStructuredName() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ CounterStructuredName() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~CounterStructuredName()

google_dataflow_api::CounterStructuredName::~CounterStructuredName ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_component_step_name()

void google_dataflow_api::CounterStructuredName::clear_component_step_name ( )

inline

Clears the 'componentStepName' attribute.

◆ clear_execution_step_name()

void google_dataflow_api::CounterStructuredName::clear_execution_step_name ( )

inline

Clears the 'executionStepName' attribute.

◆ clear_input_index()

void google_dataflow_api::CounterStructuredName::clear_input_index ( )

inline

Clears the 'inputIndex' attribute.

◆ clear_name()

void google_dataflow_api::CounterStructuredName::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_origin()

void google_dataflow_api::CounterStructuredName::clear_origin ( )

inline

Clears the 'origin' attribute.

◆ clear_origin_namespace()

void google_dataflow_api::CounterStructuredName::clear_origin_namespace ( )

inline

Clears the 'originNamespace' attribute.

◆ clear_original_requesting_step_name()

void google_dataflow_api::CounterStructuredName::clear_original_requesting_step_name ( )

inline

Clears the 'originalRequestingStepName' attribute.

◆ clear_original_step_name()

void google_dataflow_api::CounterStructuredName::clear_original_step_name ( )

inline

Clears the 'originalStepName' attribute.

◆ clear_portion()

void google_dataflow_api::CounterStructuredName::clear_portion ( )

inline

Clears the 'portion' attribute.

◆ clear_worker_id()

void google_dataflow_api::CounterStructuredName::clear_worker_id ( )

inline

Clears the 'workerId' attribute.

◆ get_component_step_name()

const StringPiece google_dataflow_api::CounterStructuredName::get_component_step_name ( ) const

inline

Get the value of the 'componentStepName' attribute.

◆ get_execution_step_name()

const StringPiece google_dataflow_api::CounterStructuredName::get_execution_step_name ( ) const

inline

Get the value of the 'executionStepName' attribute.

◆ get_input_index()

int32 google_dataflow_api::CounterStructuredName::get_input_index ( ) const

inline

Get the value of the 'inputIndex' attribute.

◆ get_name()

const StringPiece google_dataflow_api::CounterStructuredName::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_origin()

const StringPiece google_dataflow_api::CounterStructuredName::get_origin ( ) const

inline

Get the value of the 'origin' attribute.

◆ get_origin_namespace()

const StringPiece google_dataflow_api::CounterStructuredName::get_origin_namespace ( ) const

inline

Get the value of the 'originNamespace' attribute.

◆ get_original_requesting_step_name()

const StringPiece google_dataflow_api::CounterStructuredName::get_original_requesting_step_name ( ) const

inline

Get the value of the 'originalRequestingStepName' attribute.

◆ get_original_step_name()

const StringPiece google_dataflow_api::CounterStructuredName::get_original_step_name ( ) const

inline

Get the value of the 'originalStepName' attribute.

◆ get_portion()

const StringPiece google_dataflow_api::CounterStructuredName::get_portion ( ) const

inline

Get the value of the 'portion' attribute.

◆ get_worker_id()

const StringPiece google_dataflow_api::CounterStructuredName::get_worker_id ( ) const

inline

Get the value of the 'workerId' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::CounterStructuredName::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::CounterStructuredName

◆ has_component_step_name()

bool google_dataflow_api::CounterStructuredName::has_component_step_name ( ) const

inline

Determine if the 'componentStepName' attribute was set.

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

◆ has_execution_step_name()

bool google_dataflow_api::CounterStructuredName::has_execution_step_name ( ) const

inline

Determine if the 'executionStepName' attribute was set.

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

◆ has_input_index()

bool google_dataflow_api::CounterStructuredName::has_input_index ( ) const

inline

Determine if the 'inputIndex' attribute was set.

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

◆ has_name()

bool google_dataflow_api::CounterStructuredName::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::CounterStructuredName::has_origin ( ) const

inline

Determine if the 'origin' attribute was set.

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

◆ has_origin_namespace()

bool google_dataflow_api::CounterStructuredName::has_origin_namespace ( ) const

inline

Determine if the 'originNamespace' attribute was set.

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

◆ has_original_requesting_step_name()

bool google_dataflow_api::CounterStructuredName::has_original_requesting_step_name ( ) const

inline

Determine if the 'originalRequestingStepName' attribute was set.

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

◆ has_original_step_name()

bool google_dataflow_api::CounterStructuredName::has_original_step_name ( ) const

inline

Determine if the 'originalStepName' attribute was set.

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

◆ has_portion()

bool google_dataflow_api::CounterStructuredName::has_portion ( ) const

inline

Determine if the 'portion' attribute was set.

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

◆ has_worker_id()

bool google_dataflow_api::CounterStructuredName::has_worker_id ( ) const

inline

Determine if the 'workerId' attribute was set.

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

◆ New()

CounterStructuredName * google_dataflow_api::CounterStructuredName::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_component_step_name()

void google_dataflow_api::CounterStructuredName::set_component_step_name ( const StringPiece & value )

inline

Change the 'componentStepName' attribute.

Name of the optimized step being executed by the workers.

Parameters

[in] value The new value.

◆ set_execution_step_name()

void google_dataflow_api::CounterStructuredName::set_execution_step_name ( const StringPiece & value )

inline

Change the 'executionStepName' attribute.

Name of the stage. An execution step contains multiple component steps.

Parameters

[in] value The new value.

◆ set_input_index()

void google_dataflow_api::CounterStructuredName::set_input_index ( int32 value )

inline

Change the 'inputIndex' attribute.

Index of an input collection that's being read from/written to as a side input. The index identifies a step's side inputs starting by 1 (e.g. the first side input has input_index 1, the third has input_index 3). Side inputs are identified by a pair of (original_step_name, input_index). This field helps uniquely identify them.

Parameters

[in] value The new value.

◆ set_name()

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

inline

Change the 'name' attribute.

Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required.

Parameters

[in] value The new value.

◆ set_origin()

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

inline

Change the 'origin' attribute.

One of the standard Origins defined above.

Parameters

[in] value The new value.

◆ set_origin_namespace()

void google_dataflow_api::CounterStructuredName::set_origin_namespace ( const StringPiece & value )

inline

Change the 'originNamespace' attribute.

A string containing a more specific namespace of the counter's origin.

Parameters

[in] value The new value.

◆ set_original_requesting_step_name()

void google_dataflow_api::CounterStructuredName::set_original_requesting_step_name ( const StringPiece & value )

inline

Change the 'originalRequestingStepName' attribute.

The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs.

Parameters

[in] value The new value.

◆ set_original_step_name()

void google_dataflow_api::CounterStructuredName::set_original_step_name ( const StringPiece & value )

inline

Change the 'originalStepName' attribute.

System generated name of the original step in the user's graph, before optimization.

Parameters

[in] value The new value.

◆ set_portion()

void google_dataflow_api::CounterStructuredName::set_portion ( const StringPiece & value )

inline

Change the 'portion' attribute.

Portion of this counter, either key or value.

Parameters

[in] value The new value.

◆ set_worker_id()

void google_dataflow_api::CounterStructuredName::set_worker_id ( const StringPiece & value )

inline

Change the 'workerId' attribute.

ID of a particular worker.

Parameters

[in] value The new value.

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

google/dataflow_api/counter_structured_name.h
google/dataflow_api/counter_structured_name.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CounterStructuredName() [1/2]

◆ CounterStructuredName() [2/2]

◆ ~CounterStructuredName()

Member Function Documentation

◆ clear_component_step_name()

◆ clear_execution_step_name()

◆ clear_input_index()

◆ clear_name()

◆ clear_origin()

◆ clear_origin_namespace()

◆ clear_original_requesting_step_name()

◆ clear_original_step_name()

◆ clear_portion()

◆ clear_worker_id()

◆ get_component_step_name()

◆ get_execution_step_name()

◆ get_input_index()

◆ get_name()

◆ get_origin()

◆ get_origin_namespace()

◆ get_original_requesting_step_name()

◆ get_original_step_name()

◆ get_portion()

◆ get_worker_id()

◆ GetTypeName()

◆ has_component_step_name()

◆ has_execution_step_name()

◆ has_input_index()

◆ has_name()

◆ has_origin()

◆ has_origin_namespace()

◆ has_original_requesting_step_name()

◆ has_original_step_name()

◆ has_portion()

◆ has_worker_id()

◆ New()

◆ set_component_step_name()

◆ set_execution_step_name()

◆ set_input_index()

◆ set_name()

◆ set_origin()

◆ set_origin_namespace()

◆ set_original_requesting_step_name()

◆ set_original_step_name()

◆ set_portion()

◆ set_worker_id()