dataflow  v1b3
Public Member Functions | Static Public Member Functions | List of all members
google_dataflow_api::SideInputInfo Class Reference

#include <side_input_info.h>

Inheritance diagram for google_dataflow_api::SideInputInfo:

Public Member Functions

 SideInputInfo (const Json::Value &storage)
 
 SideInputInfo (Json::Value *storage)
 
virtual ~SideInputInfo ()
 
const StringPiece GetTypeName () const
 
bool has_kind () const
 
void clear_kind ()
 
const client::JsonCppAssociativeArray< client::JsonCppData > get_kind () const
 
client::JsonCppAssociativeArray< client::JsonCppData > mutable_kind ()
 
bool has_sources () const
 
void clear_sources ()
 
const client::JsonCppArray< Sourceget_sources () const
 
client::JsonCppArray< Sourcemutable_sources ()
 
bool has_tag () const
 
void clear_tag ()
 
const StringPiece get_tag () const
 
void set_tag (const StringPiece &value)
 

Static Public Member Functions

static SideInputInfoNew ()
 

Detailed Description

Information about a side input of a DoFn or an input of a SeqDoFn.

Constructor & Destructor Documentation

◆ SideInputInfo() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ SideInputInfo() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~SideInputInfo()

google_dataflow_api::SideInputInfo::~SideInputInfo ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_kind()

void google_dataflow_api::SideInputInfo::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_sources()

void google_dataflow_api::SideInputInfo::clear_sources ( )
inline

Clears the 'sources' attribute.

◆ clear_tag()

void google_dataflow_api::SideInputInfo::clear_tag ( )
inline

Clears the 'tag' attribute.

◆ get_kind()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::SideInputInfo::get_kind ( ) const
inline

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

◆ get_sources()

const client::JsonCppArray<Source > google_dataflow_api::SideInputInfo::get_sources ( ) const

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

◆ get_tag()

const StringPiece google_dataflow_api::SideInputInfo::get_tag ( ) const
inline

Get the value of the 'tag' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::SideInputInfo

◆ has_kind()

bool google_dataflow_api::SideInputInfo::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_sources()

bool google_dataflow_api::SideInputInfo::has_sources ( ) const
inline

Determine if the 'sources' attribute was set.

Returns
true if the 'sources' attribute was set.

◆ has_tag()

bool google_dataflow_api::SideInputInfo::has_tag ( ) const
inline

Determine if the 'tag' attribute was set.

Returns
true if the 'tag' attribute was set.

◆ mutable_kind()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::SideInputInfo::mutable_kind ( )
inline

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

How to interpret the source element(s) as a side input value.

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

◆ mutable_sources()

client::JsonCppArray<Source > google_dataflow_api::SideInputInfo::mutable_sources ( )

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

The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.

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

◆ New()

SideInputInfo * google_dataflow_api::SideInputInfo::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_tag()

void google_dataflow_api::SideInputInfo::set_tag ( const StringPiece &  value)
inline

Change the 'tag' attribute.

The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo.

Parameters
[in]valueThe new value.

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