#include <position.h>

Inheritance diagram for google_dataflow_api::Position:

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

	Position (Json::Value *storage)

virtual	~Position ()

const StringPiece	GetTypeName () const

bool	has_byte_offset () const

void	clear_byte_offset ()

int64	get_byte_offset () const

void	set_byte_offset (int64 value)

bool	has_concat_position () const

void	clear_concat_position ()

const ConcatPosition	get_concat_position () const

ConcatPosition	mutable_concatPosition ()

bool	has_end () const

void	clear_end ()

bool	get_end () const

void	set_end (bool value)

bool	has_key () const

void	clear_key ()

const StringPiece	get_key () const

void	set_key (const StringPiece &value)

bool	has_record_index () const

void	clear_record_index ()

int64	get_record_index () const

void	set_record_index (int64 value)

bool	has_shuffle_position () const

void	clear_shuffle_position ()

const StringPiece	get_shuffle_position () const

void	set_shuffle_position (const StringPiece &value)

Static Public Member Functions
static Position *	New ()

Detailed Description

Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index.

Constructor & Destructor Documentation

◆ Position() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Position() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Position()

google_dataflow_api::Position::~Position ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_byte_offset()

void google_dataflow_api::Position::clear_byte_offset ( )

inline

Clears the 'byteOffset' attribute.

◆ clear_concat_position()

void google_dataflow_api::Position::clear_concat_position ( )

inline

Clears the 'concatPosition' attribute.

◆ clear_end()

void google_dataflow_api::Position::clear_end ( )

inline

Clears the 'end' attribute.

◆ clear_key()

void google_dataflow_api::Position::clear_key ( )

inline

Clears the 'key' attribute.

◆ clear_record_index()

void google_dataflow_api::Position::clear_record_index ( )

inline

Clears the 'recordIndex' attribute.

◆ clear_shuffle_position()

void google_dataflow_api::Position::clear_shuffle_position ( )

inline

Clears the 'shufflePosition' attribute.

◆ get_byte_offset()

int64 google_dataflow_api::Position::get_byte_offset ( ) const

inline

Get the value of the 'byteOffset' attribute.

◆ get_concat_position()

const ConcatPosition google_dataflow_api::Position::get_concat_position ( ) const

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

◆ get_end()

bool google_dataflow_api::Position::get_end ( ) const

inline

Get the value of the 'end' attribute.

◆ get_key()

const StringPiece google_dataflow_api::Position::get_key ( ) const

inline

Get the value of the 'key' attribute.

◆ get_record_index()

int64 google_dataflow_api::Position::get_record_index ( ) const

inline

Get the value of the 'recordIndex' attribute.

◆ get_shuffle_position()

const StringPiece google_dataflow_api::Position::get_shuffle_position ( ) const

inline

Get the value of the 'shufflePosition' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::Position::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::Position

◆ has_byte_offset()

bool google_dataflow_api::Position::has_byte_offset ( ) const

inline

Determine if the 'byteOffset' attribute was set.

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

◆ has_concat_position()

bool google_dataflow_api::Position::has_concat_position ( ) const

inline

Determine if the 'concatPosition' attribute was set.

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

◆ has_end()

bool google_dataflow_api::Position::has_end ( ) const

inline

Determine if the 'end' attribute was set.

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

◆ has_key()

bool google_dataflow_api::Position::has_key ( ) const

inline

Determine if the 'key' attribute was set.

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

◆ has_record_index()

bool google_dataflow_api::Position::has_record_index ( ) const

inline

Determine if the 'recordIndex' attribute was set.

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

◆ has_shuffle_position()

bool google_dataflow_api::Position::has_shuffle_position ( ) const

inline

Determine if the 'shufflePosition' attribute was set.

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

◆ mutable_concatPosition()

ConcatPosition google_dataflow_api::Position::mutable_concatPosition ( )

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

CloudPosition is a concat position.

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

◆ New()

Position * google_dataflow_api::Position::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_byte_offset()

void google_dataflow_api::Position::set_byte_offset ( int64 value )

inline

Change the 'byteOffset' attribute.

Position is a byte offset.

Parameters

[in] value The new value.

◆ set_end()

void google_dataflow_api::Position::set_end ( bool value )

inline

Change the 'end' attribute.

Position is past all other positions. Also useful for the end position of an unbounded range.

Parameters

[in] value The new value.

◆ set_key()

void google_dataflow_api::Position::set_key ( const StringPiece & value )

inline

Change the 'key' attribute.

Position is a string key, ordered lexicographically.

Parameters

[in] value The new value.

◆ set_record_index()

void google_dataflow_api::Position::set_record_index ( int64 value )

inline

Change the 'recordIndex' attribute.

Position is a record index.

Parameters

[in] value The new value.

◆ set_shuffle_position()

void google_dataflow_api::Position::set_shuffle_position ( const StringPiece & value )

inline

Change the 'shufflePosition' attribute.

CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).

Parameters

[in] value The new value.

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

google/dataflow_api/position.h
google/dataflow_api/position.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Position() [1/2]

◆ Position() [2/2]

◆ ~Position()

Member Function Documentation

◆ clear_byte_offset()

◆ clear_concat_position()

◆ clear_end()

◆ clear_key()

◆ clear_record_index()

◆ clear_shuffle_position()

◆ get_byte_offset()

◆ get_concat_position()

◆ get_end()

◆ get_key()

◆ get_record_index()

◆ get_shuffle_position()

◆ GetTypeName()

◆ has_byte_offset()

◆ has_concat_position()

◆ has_end()

◆ has_key()

◆ has_record_index()

◆ has_shuffle_position()

◆ mutable_concatPosition()

◆ New()

◆ set_byte_offset()

◆ set_end()

◆ set_key()

◆ set_record_index()

◆ set_shuffle_position()