dataflow  v1b3
Public Member Functions | Static Public Member Functions | List of all members
google_dataflow_api::SourceSplitRequest Class Reference
Dataflow API Data Objects

#include <source_split_request.h>

Inheritance diagram for google_dataflow_api::SourceSplitRequest:

Public Member Functions

 SourceSplitRequest (const Json::Value &storage)
 
 SourceSplitRequest (Json::Value *storage)
 
virtual ~SourceSplitRequest ()
 
const StringPiece GetTypeName () const
 
bool has_options () const
 
void clear_options ()
 
const SourceSplitOptions get_options () const
 
SourceSplitOptions mutable_options ()
 
bool has_source () const
 
void clear_source ()
 
const Source get_source () const
 
Source mutable_source ()
 

Static Public Member Functions

static SourceSplitRequest * New ()
 

Detailed Description

Represents the operation to split a high-level Source specification into bundles (parts for parallel processing).

At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used "as is". Otherwise, splitting is applied recursively to each produced DerivedSource.

As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it.

Constructor & Destructor Documentation

◆ SourceSplitRequest() [1/2]

google_dataflow_api::SourceSplitRequest::SourceSplitRequest ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ SourceSplitRequest() [2/2]

google_dataflow_api::SourceSplitRequest::SourceSplitRequest ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~SourceSplitRequest()

google_dataflow_api::SourceSplitRequest::~SourceSplitRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_options()

void google_dataflow_api::SourceSplitRequest::clear_options ( )
inline

Clears the 'options' attribute.

◆ clear_source()

void google_dataflow_api::SourceSplitRequest::clear_source ( )
inline

Clears the 'source' attribute.

◆ get_options()

const SourceSplitOptions google_dataflow_api::SourceSplitRequest::get_options ( ) const

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

◆ get_source()

const Source google_dataflow_api::SourceSplitRequest::get_source ( ) const

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

◆ GetTypeName()

const StringPiece google_dataflow_api::SourceSplitRequest::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::SourceSplitRequest

◆ has_options()

bool google_dataflow_api::SourceSplitRequest::has_options ( ) const
inline

Determine if the 'options' attribute was set.

Returns
true if the 'options' attribute was set.

◆ has_source()

bool google_dataflow_api::SourceSplitRequest::has_source ( ) const
inline

Determine if the 'source' attribute was set.

Returns
true if the 'source' attribute was set.

◆ mutable_options()

SourceSplitOptions google_dataflow_api::SourceSplitRequest::mutable_options ( )

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

Hints for tuning the splitting process.

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

◆ mutable_source()

Source google_dataflow_api::SourceSplitRequest::mutable_source ( )

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

Specification of the source to be split.

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

◆ New()

SourceSplitRequest * google_dataflow_api::SourceSplitRequest::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.
The documentation for this class was generated from the following files: