google_dataflow_api::Sink Class Reference

#include <sink.h>

Inheritance diagram for google_dataflow_api::Sink:

Public Member Functions
	Sink (const Json::Value &storage)
	Sink (Json::Value *storage)
virtual	~Sink ()
const StringPiece	GetTypeName () const
bool	has_codec () const
void	clear_codec ()
const client::JsonCppAssociativeArray< client::JsonCppData >	get_codec () const
client::JsonCppAssociativeArray< client::JsonCppData >	mutable_codec ()
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 Sink *	New ()

Detailed Description

A sink that records can be encoded and written to.

Constructor & Destructor Documentation

Sink() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Sink() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Sink()

google_dataflow_api::Sink::~Sink ( )

virtual

Standard destructor.

Member Function Documentation

clear_codec()

void google_dataflow_api::Sink::clear_codec ( )

inline

Clears the 'codec' attribute.

clear_spec()

void google_dataflow_api::Sink::clear_spec ( )

inline

Clears the 'spec' attribute.

get_codec()

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

inline

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

get_spec()

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

inline

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

GetTypeName()

const StringPiece google_dataflow_api::Sink::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::Sink

has_codec()

bool google_dataflow_api::Sink::has_codec ( ) const

inline

Determine if the 'codec' attribute was set.

Returns

true if the 'codec' attribute was set.

has_spec()

bool google_dataflow_api::Sink::has_spec ( ) const

inline

Determine if the 'spec' attribute was set.

Returns

true if the 'spec' attribute was set.

mutable_codec()

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

inline

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

The codec to use to encode data written to the sink.

Returns

The result can be modified to change the attribute value.

mutable_spec()

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

inline

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

The sink to write to, plus its parameters.

Returns

The result can be modified to change the attribute value.

New()

Sink * google_dataflow_api::Sink::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:

• google/dataflow_api/sink.h
• google/dataflow_api/sink.cc