google_dataflow_api::TemplateMetadata Class Reference

#include <template_metadata.h>

Inheritance diagram for google_dataflow_api::TemplateMetadata:

Public Member Functions
	TemplateMetadata (const Json::Value &storage)
	TemplateMetadata (Json::Value *storage)
virtual	~TemplateMetadata ()
const StringPiece	GetTypeName () const
bool	has_description () const
void	clear_description ()
const StringPiece	get_description () const
void	set_description (const StringPiece &value)
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)
bool	has_parameters () const
void	clear_parameters ()
const client::JsonCppArray< ParameterMetadata >	get_parameters () const
client::JsonCppArray< ParameterMetadata >	mutable_parameters ()

Static Public Member Functions
static TemplateMetadata *	New ()

Detailed Description

Metadata describing a template.

Constructor & Destructor Documentation

TemplateMetadata() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

TemplateMetadata() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~TemplateMetadata()

google_dataflow_api::TemplateMetadata::~TemplateMetadata ( )

virtual

Standard destructor.

Member Function Documentation

clear_description()

void google_dataflow_api::TemplateMetadata::clear_description ( )

inline

Clears the 'description' attribute.

clear_name()

void google_dataflow_api::TemplateMetadata::clear_name ( )

inline

Clears the 'name' attribute.

clear_parameters()

void google_dataflow_api::TemplateMetadata::clear_parameters ( )

inline

Clears the 'parameters' attribute.

get_description()

const StringPiece google_dataflow_api::TemplateMetadata::get_description ( ) const

inline

Get the value of the 'description' attribute.

get_name()

const StringPiece google_dataflow_api::TemplateMetadata::get_name ( ) const

inline

Get the value of the 'name' attribute.

get_parameters()

const client::JsonCppArray<ParameterMetadata > google_dataflow_api::TemplateMetadata::get_parameters

(

)

const

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

GetTypeName()

const StringPiece google_dataflow_api::TemplateMetadata::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::TemplateMetadata

has_description()

bool google_dataflow_api::TemplateMetadata::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns

true if the 'description' attribute was set.

has_name()

bool google_dataflow_api::TemplateMetadata::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

has_parameters()

bool google_dataflow_api::TemplateMetadata::has_parameters ( ) const

inline

Determine if the 'parameters' attribute was set.

Returns

true if the 'parameters' attribute was set.

mutable_parameters()

client::JsonCppArray<ParameterMetadata > google_dataflow_api::TemplateMetadata::mutable_parameters

(

)

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

The parameters for the template.

Returns

The result can be modified to change the attribute value.

New()

TemplateMetadata * google_dataflow_api::TemplateMetadata::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_description()

void google_dataflow_api::TemplateMetadata::set_description ( const StringPiece &  value )

inline

Change the 'description' attribute.

Optional. A description of the template.

Parameters

[in]

value

The new value.

set_name()

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

inline

Change the 'name' attribute.

Required. The name of the template.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/template_metadata.h
• google/dataflow_api/template_metadata.cc