google_dataflow_api::SourceMetadata Class Reference

#include <source_metadata.h>

Inheritance diagram for google_dataflow_api::SourceMetadata:

Public Member Functions
	SourceMetadata (const Json::Value &storage)
	SourceMetadata (Json::Value *storage)
virtual	~SourceMetadata ()
const StringPiece	GetTypeName () const
bool	has_estimated_size_bytes () const
void	clear_estimated_size_bytes ()
int64	get_estimated_size_bytes () const
void	set_estimated_size_bytes (int64 value)
bool	has_infinite () const
void	clear_infinite ()
bool	get_infinite () const
void	set_infinite (bool value)
bool	has_produces_sorted_keys () const
void	clear_produces_sorted_keys ()
bool	get_produces_sorted_keys () const
void	set_produces_sorted_keys (bool value)

Static Public Member Functions
static SourceMetadata *	New ()

Detailed Description

Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc.

Constructor & Destructor Documentation

SourceMetadata() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

SourceMetadata() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~SourceMetadata()

google_dataflow_api::SourceMetadata::~SourceMetadata ( )

virtual

Standard destructor.

Member Function Documentation

clear_estimated_size_bytes()

void google_dataflow_api::SourceMetadata::clear_estimated_size_bytes ( )

inline

Clears the 'estimatedSizeBytes' attribute.

clear_infinite()

void google_dataflow_api::SourceMetadata::clear_infinite ( )

inline

Clears the 'infinite' attribute.

clear_produces_sorted_keys()

void google_dataflow_api::SourceMetadata::clear_produces_sorted_keys ( )

inline

Clears the 'producesSortedKeys' attribute.

get_estimated_size_bytes()

int64 google_dataflow_api::SourceMetadata::get_estimated_size_bytes ( ) const

inline

Get the value of the 'estimatedSizeBytes' attribute.

get_infinite()

bool google_dataflow_api::SourceMetadata::get_infinite ( ) const

inline

Get the value of the 'infinite' attribute.

get_produces_sorted_keys()

bool google_dataflow_api::SourceMetadata::get_produces_sorted_keys ( ) const

inline

Get the value of the 'producesSortedKeys' attribute.

GetTypeName()

const StringPiece google_dataflow_api::SourceMetadata::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::SourceMetadata

has_estimated_size_bytes()

bool google_dataflow_api::SourceMetadata::has_estimated_size_bytes ( ) const

inline

Determine if the 'estimatedSizeBytes' attribute was set.

Returns

true if the 'estimatedSizeBytes' attribute was set.

has_infinite()

bool google_dataflow_api::SourceMetadata::has_infinite ( ) const

inline

Determine if the 'infinite' attribute was set.

Returns

true if the 'infinite' attribute was set.

has_produces_sorted_keys()

bool google_dataflow_api::SourceMetadata::has_produces_sorted_keys ( ) const

inline

Determine if the 'producesSortedKeys' attribute was set.

Returns

true if the 'producesSortedKeys' attribute was set.

New()

SourceMetadata * google_dataflow_api::SourceMetadata::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_estimated_size_bytes()

void google_dataflow_api::SourceMetadata::set_estimated_size_bytes ( int64  value )

inline

Change the 'estimatedSizeBytes' attribute.

An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.

Parameters

[in]

value

The new value.

set_infinite()

void google_dataflow_api::SourceMetadata::set_infinite ( bool  value )

inline

Change the 'infinite' attribute.

Specifies that the size of this source is known to be infinite (this is a streaming source).

Parameters

[in]

value

The new value.

set_produces_sorted_keys()

void google_dataflow_api::SourceMetadata::set_produces_sorted_keys ( bool  value )

inline

Change the 'producesSortedKeys' attribute.

Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/source_metadata.h
• google/dataflow_api/source_metadata.cc