google_dataflow_api::KeyRangeLocation Class Reference

#include <key_range_location.h>

Inheritance diagram for google_dataflow_api::KeyRangeLocation:

Public Member Functions
	KeyRangeLocation (const Json::Value &storage)
	KeyRangeLocation (Json::Value *storage)
virtual	~KeyRangeLocation ()
const StringPiece	GetTypeName () const
bool	has_data_disk () const
void	clear_data_disk ()
const StringPiece	get_data_disk () const
void	set_data_disk (const StringPiece &value)
bool	has_delivery_endpoint () const
void	clear_delivery_endpoint ()
const StringPiece	get_delivery_endpoint () const
void	set_delivery_endpoint (const StringPiece &value)
bool	has_deprecated_persistent_directory () const
void	clear_deprecated_persistent_directory ()
const StringPiece	get_deprecated_persistent_directory () const
void	set_deprecated_persistent_directory (const StringPiece &value)
bool	has_end () const
void	clear_end ()
const StringPiece	get_end () const
void	set_end (const StringPiece &value)
bool	has_start () const
void	clear_start ()
const StringPiece	get_start () const
void	set_start (const StringPiece &value)

Static Public Member Functions
static KeyRangeLocation *	New ()

Detailed Description

Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.

Constructor & Destructor Documentation

KeyRangeLocation() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

KeyRangeLocation() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~KeyRangeLocation()

google_dataflow_api::KeyRangeLocation::~KeyRangeLocation ( )

virtual

Standard destructor.

Member Function Documentation

clear_data_disk()

void google_dataflow_api::KeyRangeLocation::clear_data_disk ( )

inline

Clears the 'dataDisk' attribute.

clear_delivery_endpoint()

void google_dataflow_api::KeyRangeLocation::clear_delivery_endpoint ( )

inline

Clears the 'deliveryEndpoint' attribute.

clear_deprecated_persistent_directory()

void google_dataflow_api::KeyRangeLocation::clear_deprecated_persistent_directory ( )

inline

Clears the 'deprecatedPersistentDirectory' attribute.

clear_end()

void google_dataflow_api::KeyRangeLocation::clear_end ( )

inline

Clears the 'end' attribute.

clear_start()

void google_dataflow_api::KeyRangeLocation::clear_start ( )

inline

Clears the 'start' attribute.

get_data_disk()

const StringPiece google_dataflow_api::KeyRangeLocation::get_data_disk ( ) const

inline

Get the value of the 'dataDisk' attribute.

get_delivery_endpoint()

const StringPiece google_dataflow_api::KeyRangeLocation::get_delivery_endpoint ( ) const

inline

Get the value of the 'deliveryEndpoint' attribute.

get_deprecated_persistent_directory()

const StringPiece google_dataflow_api::KeyRangeLocation::get_deprecated_persistent_directory ( ) const

inline

Get the value of the 'deprecatedPersistentDirectory' attribute.

get_end()

const StringPiece google_dataflow_api::KeyRangeLocation::get_end ( ) const

inline

Get the value of the 'end' attribute.

get_start()

const StringPiece google_dataflow_api::KeyRangeLocation::get_start ( ) const

inline

Get the value of the 'start' attribute.

GetTypeName()

const StringPiece google_dataflow_api::KeyRangeLocation::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::KeyRangeLocation

has_data_disk()

bool google_dataflow_api::KeyRangeLocation::has_data_disk ( ) const

inline

Determine if the 'dataDisk' attribute was set.

Returns

true if the 'dataDisk' attribute was set.

has_delivery_endpoint()

bool google_dataflow_api::KeyRangeLocation::has_delivery_endpoint ( ) const

inline

Determine if the 'deliveryEndpoint' attribute was set.

Returns

true if the 'deliveryEndpoint' attribute was set.

has_deprecated_persistent_directory()

bool google_dataflow_api::KeyRangeLocation::has_deprecated_persistent_directory ( ) const

inline

Determine if the 'deprecatedPersistentDirectory' attribute was set.

Returns

true if the 'deprecatedPersistentDirectory' attribute was set.

has_end()

bool google_dataflow_api::KeyRangeLocation::has_end ( ) const

inline

Determine if the 'end' attribute was set.

Returns

true if the 'end' attribute was set.

has_start()

bool google_dataflow_api::KeyRangeLocation::has_start ( ) const

inline

Determine if the 'start' attribute was set.

Returns

true if the 'start' attribute was set.

New()

KeyRangeLocation * google_dataflow_api::KeyRangeLocation::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_data_disk()

void google_dataflow_api::KeyRangeLocation::set_data_disk ( const StringPiece &  value )

inline

Change the 'dataDisk' attribute.

The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1".

Parameters

[in]

value

The new value.

set_delivery_endpoint()

void google_dataflow_api::KeyRangeLocation::set_delivery_endpoint ( const StringPiece &  value )

inline

Change the 'deliveryEndpoint' attribute.

The physical location of this range assignment to be used for streaming computation cross-worker message delivery.

Parameters

[in]

value

The new value.

set_deprecated_persistent_directory()

void google_dataflow_api::KeyRangeLocation::set_deprecated_persistent_directory ( const StringPiece &  value )

inline

Change the 'deprecatedPersistentDirectory' attribute.

Deprecated:

DEPRECATED. The location of the persistent state for this range, as a persistent directory in the worker local filesystem.

Parameters

[in]

value

The new value.

set_end()

void google_dataflow_api::KeyRangeLocation::set_end ( const StringPiece &  value )

inline

Change the 'end' attribute.

The end (exclusive) of the key range.

Parameters

[in]

value

The new value.

set_start()

void google_dataflow_api::KeyRangeLocation::set_start ( const StringPiece &  value )

inline

Change the 'start' attribute.

The start (inclusive) of the key range.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/key_range_location.h
• google/dataflow_api/key_range_location.cc