#include <source.h>

Inheritance diagram for google_dataflow_api::Source:

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

	Source (Json::Value *storage)

virtual	~Source ()

const StringPiece	GetTypeName () const

bool	has_base_specs () const

void	clear_base_specs ()

const client::JsonCppArray< client::JsonCppAssociativeArray< client::JsonCppData > >	get_base_specs () const

client::JsonCppArray< client::JsonCppAssociativeArray< client::JsonCppData > >	mutable_baseSpecs ()

bool	has_codec () const

void	clear_codec ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_codec () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_codec ()

bool	has_does_not_need_splitting () const

void	clear_does_not_need_splitting ()

bool	get_does_not_need_splitting () const

void	set_does_not_need_splitting (bool value)

bool	has_metadata () const

void	clear_metadata ()

const SourceMetadata	get_metadata () const

SourceMetadata	mutable_metadata ()

bool	has_spec () const

void	clear_spec ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_spec () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_spec ()

Static Public Member Functions
static Source *	New ()

Detailed Description

A source that records can be read and decoded from.

Constructor & Destructor Documentation

◆ Source() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Source() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Source()

google_dataflow_api::Source::~Source ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_base_specs()

void google_dataflow_api::Source::clear_base_specs ( )

inline

Clears the 'baseSpecs' attribute.

◆ clear_codec()

void google_dataflow_api::Source::clear_codec ( )

inline

Clears the 'codec' attribute.

◆ clear_does_not_need_splitting()

void google_dataflow_api::Source::clear_does_not_need_splitting ( )

inline

Clears the 'doesNotNeedSplitting' attribute.

◆ clear_metadata()

void google_dataflow_api::Source::clear_metadata ( )

inline

Clears the 'metadata' attribute.

◆ clear_spec()

void google_dataflow_api::Source::clear_spec ( )

inline

Clears the 'spec' attribute.

◆ get_base_specs()

const client::JsonCppArray<client::JsonCppAssociativeArray<client::JsonCppData > > google_dataflow_api::Source::get_base_specs ( ) const

inline

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

◆ get_codec()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Source::get_codec ( ) const

inline

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

◆ get_does_not_need_splitting()

bool google_dataflow_api::Source::get_does_not_need_splitting ( ) const

inline

Get the value of the 'doesNotNeedSplitting' attribute.

◆ get_metadata()

const SourceMetadata google_dataflow_api::Source::get_metadata ( ) const

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

◆ get_spec()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Source::get_spec ( ) const

inline

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

◆ GetTypeName()

const StringPiece google_dataflow_api::Source::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::Source

◆ has_base_specs()

bool google_dataflow_api::Source::has_base_specs ( ) const

inline

Determine if the 'baseSpecs' attribute was set.

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

◆ has_codec()

bool google_dataflow_api::Source::has_codec ( ) const

inline

Determine if the 'codec' attribute was set.

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

◆ has_does_not_need_splitting()

bool google_dataflow_api::Source::has_does_not_need_splitting ( ) const

inline

Determine if the 'doesNotNeedSplitting' attribute was set.

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

◆ has_metadata()

bool google_dataflow_api::Source::has_metadata ( ) const

inline

Determine if the 'metadata' attribute was set.

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

◆ has_spec()

bool google_dataflow_api::Source::has_spec ( ) const

inline

Determine if the 'spec' attribute was set.

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

◆ mutable_baseSpecs()

client::JsonCppArray<client::JsonCppAssociativeArray<client::JsonCppData > > google_dataflow_api::Source::mutable_baseSpecs ( )

inline

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

While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).

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

◆ mutable_codec()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Source::mutable_codec ( )

inline

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

The codec to use to decode data read from the source.

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

◆ mutable_metadata()

SourceMetadata google_dataflow_api::Source::mutable_metadata ( )

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

Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest).

This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.

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

◆ mutable_spec()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Source::mutable_spec ( )

inline

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

The source to read from, plus its parameters.

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

◆ New()

Source * google_dataflow_api::Source::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_does_not_need_splitting()

void google_dataflow_api::Source::set_does_not_need_splitting ( bool value )

inline

Change the 'doesNotNeedSplitting' attribute.

Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT.

E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip.

See SourceSplitRequest for an overview of the splitting process.

This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.

Parameters

[in] value The new value.

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

google/dataflow_api/source.h
google/dataflow_api/source.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Source() [1/2]

◆ Source() [2/2]

◆ ~Source()

Member Function Documentation

◆ clear_base_specs()

◆ clear_codec()

◆ clear_does_not_need_splitting()

◆ clear_metadata()

◆ clear_spec()

◆ get_base_specs()

◆ get_codec()

◆ get_does_not_need_splitting()

◆ get_metadata()

◆ get_spec()

◆ GetTypeName()

◆ has_base_specs()

◆ has_codec()

◆ has_does_not_need_splitting()

◆ has_metadata()

◆ has_spec()

◆ mutable_baseSpecs()

◆ mutable_codec()

◆ mutable_metadata()

◆ mutable_spec()

◆ New()

◆ set_does_not_need_splitting()