google_dataflow_api::LaunchTemplateParameters Class Reference

#include <launch_template_parameters.h>

Inheritance diagram for google_dataflow_api::LaunchTemplateParameters:

Public Member Functions
	LaunchTemplateParameters (const Json::Value &storage)
	LaunchTemplateParameters (Json::Value *storage)
virtual	~LaunchTemplateParameters ()
const StringPiece	GetTypeName () const
bool	has_environment () const
void	clear_environment ()
const RuntimeEnvironment	get_environment () const
RuntimeEnvironment	mutable_environment ()
bool	has_job_name () const
void	clear_job_name ()
const StringPiece	get_job_name () const
void	set_job_name (const StringPiece &value)
bool	has_parameters () const
void	clear_parameters ()
const client::JsonCppAssociativeArray< string >	get_parameters () const
client::JsonCppAssociativeArray< string >	mutable_parameters ()
bool	has_transform_name_mapping () const
void	clear_transform_name_mapping ()
const client::JsonCppAssociativeArray< string >	get_transform_name_mapping () const
client::JsonCppAssociativeArray< string >	mutable_transformNameMapping ()
bool	has_update () const
void	clear_update ()
bool	get_update () const
void	set_update (bool value)

Static Public Member Functions
static LaunchTemplateParameters *	New ()

Detailed Description

Parameters to provide to the template being launched.

Constructor & Destructor Documentation

LaunchTemplateParameters() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

LaunchTemplateParameters() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~LaunchTemplateParameters()

google_dataflow_api::LaunchTemplateParameters::~LaunchTemplateParameters ( )

virtual

Standard destructor.

Member Function Documentation

clear_environment()

void google_dataflow_api::LaunchTemplateParameters::clear_environment ( )

inline

Clears the 'environment' attribute.

clear_job_name()

void google_dataflow_api::LaunchTemplateParameters::clear_job_name ( )

inline

Clears the 'jobName' attribute.

clear_parameters()

void google_dataflow_api::LaunchTemplateParameters::clear_parameters ( )

inline

Clears the 'parameters' attribute.

clear_transform_name_mapping()

void google_dataflow_api::LaunchTemplateParameters::clear_transform_name_mapping ( )

inline

Clears the 'transformNameMapping' attribute.

clear_update()

void google_dataflow_api::LaunchTemplateParameters::clear_update ( )

inline

Clears the 'update' attribute.

get_environment()

const RuntimeEnvironment google_dataflow_api::LaunchTemplateParameters::get_environment

(

)

const

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

get_job_name()

const StringPiece google_dataflow_api::LaunchTemplateParameters::get_job_name ( ) const

inline

Get the value of the 'jobName' attribute.

get_parameters()

const client::JsonCppAssociativeArray<string > google_dataflow_api::LaunchTemplateParameters::get_parameters ( ) const

inline

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

get_transform_name_mapping()

const client::JsonCppAssociativeArray<string > google_dataflow_api::LaunchTemplateParameters::get_transform_name_mapping ( ) const

inline

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

get_update()

bool google_dataflow_api::LaunchTemplateParameters::get_update ( ) const

inline

Get the value of the 'update' attribute.

GetTypeName()

const StringPiece google_dataflow_api::LaunchTemplateParameters::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::LaunchTemplateParameters

has_environment()

bool google_dataflow_api::LaunchTemplateParameters::has_environment ( ) const

inline

Determine if the 'environment' attribute was set.

Returns

true if the 'environment' attribute was set.

has_job_name()

bool google_dataflow_api::LaunchTemplateParameters::has_job_name ( ) const

inline

Determine if the 'jobName' attribute was set.

Returns

true if the 'jobName' attribute was set.

has_parameters()

bool google_dataflow_api::LaunchTemplateParameters::has_parameters ( ) const

inline

Determine if the 'parameters' attribute was set.

Returns

true if the 'parameters' attribute was set.

has_transform_name_mapping()

bool google_dataflow_api::LaunchTemplateParameters::has_transform_name_mapping ( ) const

inline

Determine if the 'transformNameMapping' attribute was set.

Returns

true if the 'transformNameMapping' attribute was set.

has_update()

bool google_dataflow_api::LaunchTemplateParameters::has_update ( ) const

inline

Determine if the 'update' attribute was set.

Returns

true if the 'update' attribute was set.

mutable_environment()

RuntimeEnvironment google_dataflow_api::LaunchTemplateParameters::mutable_environment

(

)

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

The runtime environment for the job.

Returns

The result can be modified to change the attribute value.

mutable_parameters()

client::JsonCppAssociativeArray<string > google_dataflow_api::LaunchTemplateParameters::mutable_parameters ( )

inline

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

The runtime parameters to pass to the job.

Returns

The result can be modified to change the attribute value.

mutable_transformNameMapping()

client::JsonCppAssociativeArray<string > google_dataflow_api::LaunchTemplateParameters::mutable_transformNameMapping ( )

inline

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

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

Returns

The result can be modified to change the attribute value.

New()

LaunchTemplateParameters * google_dataflow_api::LaunchTemplateParameters::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_job_name()

void google_dataflow_api::LaunchTemplateParameters::set_job_name ( const StringPiece &  value )

inline

Change the 'jobName' attribute.

Required. The job name to use for the created job.

Parameters

[in]

value

The new value.

set_update()

void google_dataflow_api::LaunchTemplateParameters::set_update ( bool  value )

inline

Change the 'update' attribute.

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/launch_template_parameters.h
• google/dataflow_api/launch_template_parameters.cc