google_dataflow_api::Step Class Reference

#include <step.h>

Inheritance diagram for google_dataflow_api::Step:

Public Member Functions
	Step (const Json::Value &storage)
	Step (Json::Value *storage)
virtual	~Step ()
const StringPiece	GetTypeName () const
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)
bool	has_properties () const
void	clear_properties ()
const client::JsonCppAssociativeArray< client::JsonCppData >	get_properties () const
client::JsonCppAssociativeArray< client::JsonCppData >	mutable_properties ()

Static Public Member Functions
static Step *	New ()

Detailed Description

Defines a particular step within a Cloud Dataflow job.

A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job.

Here's an example of a sequence of steps which together implement a Map-Reduce job:

• Read a collection of data from some source, parsing the

user

defined function to map each element to some value.

element

specific key value.

multiply

keyed collection into a.

uniquely

keyed collection.

Map

Reduce.

Constructor & Destructor Documentation

Step() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Step() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Step()

google_dataflow_api::Step::~Step ( )

virtual

Standard destructor.

Member Function Documentation

clear_kind()

void google_dataflow_api::Step::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_name()

void google_dataflow_api::Step::clear_name ( )

inline

Clears the 'name' attribute.

clear_properties()

void google_dataflow_api::Step::clear_properties ( )

inline

Clears the 'properties' attribute.

get_kind()

const StringPiece google_dataflow_api::Step::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_name()

const StringPiece google_dataflow_api::Step::get_name ( ) const

inline

Get the value of the 'name' attribute.

get_properties()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Step::get_properties ( ) const

inline

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

GetTypeName()

const StringPiece google_dataflow_api::Step::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::Step

has_kind()

bool google_dataflow_api::Step::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_name()

bool google_dataflow_api::Step::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

has_properties()

bool google_dataflow_api::Step::has_properties ( ) const

inline

Determine if the 'properties' attribute was set.

Returns

true if the 'properties' attribute was set.

mutable_properties()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Step::mutable_properties ( )

inline

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

Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

Returns

The result can be modified to change the attribute value.

New()

Step * google_dataflow_api::Step::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_kind()

void google_dataflow_api::Step::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

The kind of step in the Cloud Dataflow job.

Parameters

[in]

value

The new value.

set_name()

void google_dataflow_api::Step::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/step.h
• google/dataflow_api/step.cc