google_dataflow_api::SourceSplitResponse Class Reference

#include <source_split_response.h>

Inheritance diagram for google_dataflow_api::SourceSplitResponse:

Public Member Functions
	SourceSplitResponse (const Json::Value &storage)
	SourceSplitResponse (Json::Value *storage)
virtual	~SourceSplitResponse ()
const StringPiece	GetTypeName () const
bool	has_bundles () const
void	clear_bundles ()
const client::JsonCppArray< DerivedSource >	get_bundles () const
client::JsonCppArray< DerivedSource >	mutable_bundles ()
bool	has_outcome () const
void	clear_outcome ()
const StringPiece	get_outcome () const
void	set_outcome (const StringPiece &value)
bool	has_shards () const
void	clear_shards ()
const client::JsonCppArray< SourceSplitShard >	get_shards () const
client::JsonCppArray< SourceSplitShard >	mutable_shards ()

Static Public Member Functions
static SourceSplitResponse *	New ()

Detailed Description

The response to a SourceSplitRequest.

Constructor & Destructor Documentation

SourceSplitResponse() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

SourceSplitResponse() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~SourceSplitResponse()

google_dataflow_api::SourceSplitResponse::~SourceSplitResponse ( )

virtual

Standard destructor.

Member Function Documentation

clear_bundles()

void google_dataflow_api::SourceSplitResponse::clear_bundles ( )

inline

Clears the 'bundles' attribute.

clear_outcome()

void google_dataflow_api::SourceSplitResponse::clear_outcome ( )

inline

Clears the 'outcome' attribute.

clear_shards()

void google_dataflow_api::SourceSplitResponse::clear_shards ( )

inline

Clears the 'shards' attribute.

get_bundles()

const client::JsonCppArray<DerivedSource > google_dataflow_api::SourceSplitResponse::get_bundles

(

)

const

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

get_outcome()

const StringPiece google_dataflow_api::SourceSplitResponse::get_outcome ( ) const

inline

Get the value of the 'outcome' attribute.

get_shards()

const client::JsonCppArray<SourceSplitShard > google_dataflow_api::SourceSplitResponse::get_shards

(

)

const

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

GetTypeName()

const StringPiece google_dataflow_api::SourceSplitResponse::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::SourceSplitResponse

has_bundles()

bool google_dataflow_api::SourceSplitResponse::has_bundles ( ) const

inline

Determine if the 'bundles' attribute was set.

Returns

true if the 'bundles' attribute was set.

has_outcome()

bool google_dataflow_api::SourceSplitResponse::has_outcome ( ) const

inline

Determine if the 'outcome' attribute was set.

Returns

true if the 'outcome' attribute was set.

has_shards()

bool google_dataflow_api::SourceSplitResponse::has_shards ( ) const

inline

Determine if the 'shards' attribute was set.

Returns

true if the 'shards' attribute was set.

mutable_bundles()

client::JsonCppArray<DerivedSource > google_dataflow_api::SourceSplitResponse::mutable_bundles

(

)

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

If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which the source was split. Otherwise this field is ignored. This list can be empty, which means the source represents an empty input.

Returns

The result can be modified to change the attribute value.

mutable_shards()

client::JsonCppArray<SourceSplitShard > google_dataflow_api::SourceSplitResponse::mutable_shards

(

)

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

Deprecated:

DEPRECATED in favor of bundles.

Returns

The result can be modified to change the attribute value.

New()

SourceSplitResponse * google_dataflow_api::SourceSplitResponse::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_outcome()

void google_dataflow_api::SourceSplitResponse::set_outcome ( const StringPiece &  value )

inline

Change the 'outcome' attribute.

Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" without splitting. "bundles" is ignored in this case. If this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the source was split.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/source_split_response.h
• google/dataflow_api/source_split_response.cc