dataflow  v1b3
Public Member Functions | Static Public Member Functions | List of all members
google_dataflow_api::CreateJobFromTemplateRequest Class Reference

#include <create_job_from_template_request.h>

Inheritance diagram for google_dataflow_api::CreateJobFromTemplateRequest:

Public Member Functions

 CreateJobFromTemplateRequest (const Json::Value &storage)
 
 CreateJobFromTemplateRequest (Json::Value *storage)
 
virtual ~CreateJobFromTemplateRequest ()
 
const StringPiece GetTypeName () const
 
bool has_environment () const
 
void clear_environment ()
 
const RuntimeEnvironment get_environment () const
 
RuntimeEnvironment mutable_environment ()
 
bool has_gcs_path () const
 
void clear_gcs_path ()
 
const StringPiece get_gcs_path () const
 
void set_gcs_path (const StringPiece &value)
 
bool has_job_name () const
 
void clear_job_name ()
 
const StringPiece get_job_name () const
 
void set_job_name (const StringPiece &value)
 
bool has_location () const
 
void clear_location ()
 
const StringPiece get_location () const
 
void set_location (const StringPiece &value)
 
bool has_parameters () const
 
void clear_parameters ()
 
const client::JsonCppAssociativeArray< string > get_parameters () const
 
client::JsonCppAssociativeArray< string > mutable_parameters ()
 

Static Public Member Functions

static CreateJobFromTemplateRequestNew ()
 

Detailed Description

A request to create a Cloud Dataflow job from a template.

Constructor & Destructor Documentation

◆ CreateJobFromTemplateRequest() [1/2]

google_dataflow_api::CreateJobFromTemplateRequest::CreateJobFromTemplateRequest ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ CreateJobFromTemplateRequest() [2/2]

google_dataflow_api::CreateJobFromTemplateRequest::CreateJobFromTemplateRequest ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~CreateJobFromTemplateRequest()

google_dataflow_api::CreateJobFromTemplateRequest::~CreateJobFromTemplateRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_environment()

void google_dataflow_api::CreateJobFromTemplateRequest::clear_environment ( )
inline

Clears the 'environment' attribute.

◆ clear_gcs_path()

void google_dataflow_api::CreateJobFromTemplateRequest::clear_gcs_path ( )
inline

Clears the 'gcsPath' attribute.

◆ clear_job_name()

void google_dataflow_api::CreateJobFromTemplateRequest::clear_job_name ( )
inline

Clears the 'jobName' attribute.

◆ clear_location()

void google_dataflow_api::CreateJobFromTemplateRequest::clear_location ( )
inline

Clears the 'location' attribute.

◆ clear_parameters()

void google_dataflow_api::CreateJobFromTemplateRequest::clear_parameters ( )
inline

Clears the 'parameters' attribute.

◆ get_environment()

const RuntimeEnvironment google_dataflow_api::CreateJobFromTemplateRequest::get_environment ( ) const

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

◆ get_gcs_path()

const StringPiece google_dataflow_api::CreateJobFromTemplateRequest::get_gcs_path ( ) const
inline

Get the value of the 'gcsPath' attribute.

◆ get_job_name()

const StringPiece google_dataflow_api::CreateJobFromTemplateRequest::get_job_name ( ) const
inline

Get the value of the 'jobName' attribute.

◆ get_location()

const StringPiece google_dataflow_api::CreateJobFromTemplateRequest::get_location ( ) const
inline

Get the value of the 'location' attribute.

◆ get_parameters()

const client::JsonCppAssociativeArray<string > google_dataflow_api::CreateJobFromTemplateRequest::get_parameters ( ) const
inline

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

◆ GetTypeName()

const StringPiece google_dataflow_api::CreateJobFromTemplateRequest::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::CreateJobFromTemplateRequest

◆ has_environment()

bool google_dataflow_api::CreateJobFromTemplateRequest::has_environment ( ) const
inline

Determine if the 'environment' attribute was set.

Returns
true if the 'environment' attribute was set.

◆ has_gcs_path()

bool google_dataflow_api::CreateJobFromTemplateRequest::has_gcs_path ( ) const
inline

Determine if the 'gcsPath' attribute was set.

Returns
true if the 'gcsPath' attribute was set.

◆ has_job_name()

bool google_dataflow_api::CreateJobFromTemplateRequest::has_job_name ( ) const
inline

Determine if the 'jobName' attribute was set.

Returns
true if the 'jobName' attribute was set.

◆ has_location()

bool google_dataflow_api::CreateJobFromTemplateRequest::has_location ( ) const
inline

Determine if the 'location' attribute was set.

Returns
true if the 'location' attribute was set.

◆ has_parameters()

bool google_dataflow_api::CreateJobFromTemplateRequest::has_parameters ( ) const
inline

Determine if the 'parameters' attribute was set.

Returns
true if the 'parameters' attribute was set.

◆ mutable_environment()

RuntimeEnvironment google_dataflow_api::CreateJobFromTemplateRequest::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::CreateJobFromTemplateRequest::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.

◆ New()

CreateJobFromTemplateRequest * google_dataflow_api::CreateJobFromTemplateRequest::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_gcs_path()

void google_dataflow_api::CreateJobFromTemplateRequest::set_gcs_path ( const StringPiece &  value)
inline

Change the 'gcsPath' attribute.

Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

Parameters
[in]valueThe new value.

◆ set_job_name()

void google_dataflow_api::CreateJobFromTemplateRequest::set_job_name ( const StringPiece &  value)
inline

Change the 'jobName' attribute.

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

Parameters
[in]valueThe new value.

◆ set_location()

void google_dataflow_api::CreateJobFromTemplateRequest::set_location ( const StringPiece &  value)
inline

Change the 'location' attribute.

The regional endpoint to which to direct the request.

Parameters
[in]valueThe new value.

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