#include <parameter_metadata.h>

Inheritance diagram for google_dataflow_api::ParameterMetadata:

Public Member Functions
	ParameterMetadata (const Json::Value &storage)

	ParameterMetadata (Json::Value *storage)

virtual	~ParameterMetadata ()

const StringPiece	GetTypeName () const

bool	has_help_text () const

void	clear_help_text ()

const StringPiece	get_help_text () const

void	set_help_text (const StringPiece &value)

bool	has_is_optional () const

void	clear_is_optional ()

bool	get_is_optional () const

void	set_is_optional (bool value)

bool	has_label () const

void	clear_label ()

const StringPiece	get_label () const

void	set_label (const StringPiece &value)

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_param_type () const

void	clear_param_type ()

const StringPiece	get_param_type () const

void	set_param_type (const StringPiece &value)

bool	has_regexes () const

void	clear_regexes ()

const client::JsonCppArray< string >	get_regexes () const

client::JsonCppArray< string >	mutable_regexes ()

Static Public Member Functions
static ParameterMetadata *	New ()

Detailed Description

Metadata for a specific parameter.

Constructor & Destructor Documentation

◆ ParameterMetadata() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ParameterMetadata() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~ParameterMetadata()

google_dataflow_api::ParameterMetadata::~ParameterMetadata ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_help_text()

void google_dataflow_api::ParameterMetadata::clear_help_text ( )

inline

Clears the 'helpText' attribute.

◆ clear_is_optional()

void google_dataflow_api::ParameterMetadata::clear_is_optional ( )

inline

Clears the 'isOptional' attribute.

◆ clear_label()

void google_dataflow_api::ParameterMetadata::clear_label ( )

inline

Clears the 'label' attribute.

◆ clear_name()

void google_dataflow_api::ParameterMetadata::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_param_type()

void google_dataflow_api::ParameterMetadata::clear_param_type ( )

inline

Clears the 'paramType' attribute.

◆ clear_regexes()

void google_dataflow_api::ParameterMetadata::clear_regexes ( )

inline

Clears the 'regexes' attribute.

◆ get_help_text()

const StringPiece google_dataflow_api::ParameterMetadata::get_help_text ( ) const

inline

Get the value of the 'helpText' attribute.

◆ get_is_optional()

bool google_dataflow_api::ParameterMetadata::get_is_optional ( ) const

inline

Get the value of the 'isOptional' attribute.

◆ get_label()

const StringPiece google_dataflow_api::ParameterMetadata::get_label ( ) const

inline

Get the value of the 'label' attribute.

◆ get_name()

const StringPiece google_dataflow_api::ParameterMetadata::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_param_type()

const StringPiece google_dataflow_api::ParameterMetadata::get_param_type ( ) const

inline

Get the value of the 'paramType' attribute.

◆ get_regexes()

const client::JsonCppArray<string > google_dataflow_api::ParameterMetadata::get_regexes ( ) const

inline

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

◆ GetTypeName()

const StringPiece google_dataflow_api::ParameterMetadata::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::ParameterMetadata

◆ has_help_text()

bool google_dataflow_api::ParameterMetadata::has_help_text ( ) const

inline

Determine if the 'helpText' attribute was set.

Returns: true if the 'helpText' attribute was set.

◆ has_is_optional()

bool google_dataflow_api::ParameterMetadata::has_is_optional ( ) const

inline

Determine if the 'isOptional' attribute was set.

Returns: true if the 'isOptional' attribute was set.

◆ has_label()

bool google_dataflow_api::ParameterMetadata::has_label ( ) const

inline

Determine if the 'label' attribute was set.

Returns: true if the 'label' attribute was set.

◆ has_name()

bool google_dataflow_api::ParameterMetadata::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_param_type()

bool google_dataflow_api::ParameterMetadata::has_param_type ( ) const

inline

Determine if the 'paramType' attribute was set.

Returns: true if the 'paramType' attribute was set.

◆ has_regexes()

bool google_dataflow_api::ParameterMetadata::has_regexes ( ) const

inline

Determine if the 'regexes' attribute was set.

Returns: true if the 'regexes' attribute was set.

◆ mutable_regexes()

client::JsonCppArray<string > google_dataflow_api::ParameterMetadata::mutable_regexes ( )

inline

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

Optional. Regexes that the parameter must match.

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

◆ New()

ParameterMetadata * google_dataflow_api::ParameterMetadata::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_help_text()

void google_dataflow_api::ParameterMetadata::set_help_text ( const StringPiece & value )

inline

Change the 'helpText' attribute.

Required. The help text to display for the parameter.

Parameters

[in] value The new value.

◆ set_is_optional()

void google_dataflow_api::ParameterMetadata::set_is_optional ( bool value )

inline

Change the 'isOptional' attribute.

Optional. Whether the parameter is optional. Defaults to false.

Parameters

[in] value The new value.

◆ set_label()

void google_dataflow_api::ParameterMetadata::set_label ( const StringPiece & value )

inline

Change the 'label' attribute.

Required. The label to display for the parameter.

Parameters

[in] value The new value.

◆ set_name()

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

inline

Change the 'name' attribute.

Required. The name of the parameter.

Parameters

[in] value The new value.

◆ set_param_type()

void google_dataflow_api::ParameterMetadata::set_param_type ( const StringPiece & value )

inline

Change the 'paramType' attribute.

Optional. The type of the parameter. Used for selecting input picker.

Parameters

[in] value The new value.

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

google/dataflow_api/parameter_metadata.h
google/dataflow_api/parameter_metadata.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ParameterMetadata() [1/2]

◆ ParameterMetadata() [2/2]

◆ ~ParameterMetadata()

Member Function Documentation

◆ clear_help_text()

◆ clear_is_optional()

◆ clear_label()

◆ clear_name()

◆ clear_param_type()

◆ clear_regexes()

◆ get_help_text()

◆ get_is_optional()

◆ get_label()

◆ get_name()

◆ get_param_type()

◆ get_regexes()

◆ GetTypeName()

◆ has_help_text()

◆ has_is_optional()

◆ has_label()

◆ has_name()

◆ has_param_type()

◆ has_regexes()

◆ mutable_regexes()

◆ New()

◆ set_help_text()

◆ set_is_optional()

◆ set_label()

◆ set_name()

◆ set_param_type()