#include <runtime_environment.h>

Inheritance diagram for google_dataflow_api::RuntimeEnvironment:

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

	RuntimeEnvironment (Json::Value *storage)

virtual	~RuntimeEnvironment ()

const StringPiece	GetTypeName () const

bool	has_additional_experiments () const

void	clear_additional_experiments ()

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

client::JsonCppArray< string >	mutable_additionalExperiments ()

bool	has_additional_user_labels () const

void	clear_additional_user_labels ()

const client::JsonCppAssociativeArray< string >	get_additional_user_labels () const

client::JsonCppAssociativeArray< string >	mutable_additionalUserLabels ()

bool	has_bypass_temp_dir_validation () const

void	clear_bypass_temp_dir_validation ()

bool	get_bypass_temp_dir_validation () const

void	set_bypass_temp_dir_validation (bool value)

bool	has_ip_configuration () const

void	clear_ip_configuration ()

const StringPiece	get_ip_configuration () const

void	set_ip_configuration (const StringPiece &value)

bool	has_kms_key_name () const

void	clear_kms_key_name ()

const StringPiece	get_kms_key_name () const

void	set_kms_key_name (const StringPiece &value)

bool	has_machine_type () const

void	clear_machine_type ()

const StringPiece	get_machine_type () const

void	set_machine_type (const StringPiece &value)

bool	has_max_workers () const

void	clear_max_workers ()

int32	get_max_workers () const

void	set_max_workers (int32 value)

bool	has_network () const

void	clear_network ()

const StringPiece	get_network () const

void	set_network (const StringPiece &value)

bool	has_num_workers () const

void	clear_num_workers ()

int32	get_num_workers () const

void	set_num_workers (int32 value)

bool	has_service_account_email () const

void	clear_service_account_email ()

const StringPiece	get_service_account_email () const

void	set_service_account_email (const StringPiece &value)

bool	has_subnetwork () const

void	clear_subnetwork ()

const StringPiece	get_subnetwork () const

void	set_subnetwork (const StringPiece &value)

bool	has_temp_location () const

void	clear_temp_location ()

const StringPiece	get_temp_location () const

void	set_temp_location (const StringPiece &value)

bool	has_worker_region () const

void	clear_worker_region ()

const StringPiece	get_worker_region () const

void	set_worker_region (const StringPiece &value)

bool	has_worker_zone () const

void	clear_worker_zone ()

const StringPiece	get_worker_zone () const

void	set_worker_zone (const StringPiece &value)

bool	has_zone () const

void	clear_zone ()

const StringPiece	get_zone () const

void	set_zone (const StringPiece &value)

Static Public Member Functions
static RuntimeEnvironment *	New ()

Detailed Description

The environment values to set at runtime.

Constructor & Destructor Documentation

◆ RuntimeEnvironment() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ RuntimeEnvironment() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~RuntimeEnvironment()

google_dataflow_api::RuntimeEnvironment::~RuntimeEnvironment ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_additional_experiments()

void google_dataflow_api::RuntimeEnvironment::clear_additional_experiments ( )

inline

Clears the 'additionalExperiments' attribute.

◆ clear_additional_user_labels()

void google_dataflow_api::RuntimeEnvironment::clear_additional_user_labels ( )

inline

Clears the 'additionalUserLabels' attribute.

◆ clear_bypass_temp_dir_validation()

void google_dataflow_api::RuntimeEnvironment::clear_bypass_temp_dir_validation ( )

inline

Clears the 'bypassTempDirValidation' attribute.

◆ clear_ip_configuration()

void google_dataflow_api::RuntimeEnvironment::clear_ip_configuration ( )

inline

Clears the 'ipConfiguration' attribute.

◆ clear_kms_key_name()

void google_dataflow_api::RuntimeEnvironment::clear_kms_key_name ( )

inline

Clears the 'kmsKeyName' attribute.

◆ clear_machine_type()

void google_dataflow_api::RuntimeEnvironment::clear_machine_type ( )

inline

Clears the 'machineType' attribute.

◆ clear_max_workers()

void google_dataflow_api::RuntimeEnvironment::clear_max_workers ( )

inline

Clears the 'maxWorkers' attribute.

◆ clear_network()

void google_dataflow_api::RuntimeEnvironment::clear_network ( )

inline

Clears the 'network' attribute.

◆ clear_num_workers()

void google_dataflow_api::RuntimeEnvironment::clear_num_workers ( )

inline

Clears the 'numWorkers' attribute.

◆ clear_service_account_email()

void google_dataflow_api::RuntimeEnvironment::clear_service_account_email ( )

inline

Clears the 'serviceAccountEmail' attribute.

◆ clear_subnetwork()

void google_dataflow_api::RuntimeEnvironment::clear_subnetwork ( )

inline

Clears the 'subnetwork' attribute.

◆ clear_temp_location()

void google_dataflow_api::RuntimeEnvironment::clear_temp_location ( )

inline

Clears the 'tempLocation' attribute.

◆ clear_worker_region()

void google_dataflow_api::RuntimeEnvironment::clear_worker_region ( )

inline

Clears the 'workerRegion' attribute.

◆ clear_worker_zone()

void google_dataflow_api::RuntimeEnvironment::clear_worker_zone ( )

inline

Clears the 'workerZone' attribute.

◆ clear_zone()

void google_dataflow_api::RuntimeEnvironment::clear_zone ( )

inline

Clears the 'zone' attribute.

◆ get_additional_experiments()

const client::JsonCppArray<string > google_dataflow_api::RuntimeEnvironment::get_additional_experiments ( ) const

inline

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

◆ get_additional_user_labels()

const client::JsonCppAssociativeArray<string > google_dataflow_api::RuntimeEnvironment::get_additional_user_labels ( ) const

inline

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

◆ get_bypass_temp_dir_validation()

bool google_dataflow_api::RuntimeEnvironment::get_bypass_temp_dir_validation ( ) const

inline

Get the value of the 'bypassTempDirValidation' attribute.

◆ get_ip_configuration()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_ip_configuration ( ) const

inline

Get the value of the 'ipConfiguration' attribute.

◆ get_kms_key_name()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_kms_key_name ( ) const

inline

Get the value of the 'kmsKeyName' attribute.

◆ get_machine_type()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_machine_type ( ) const

inline

Get the value of the 'machineType' attribute.

◆ get_max_workers()

int32 google_dataflow_api::RuntimeEnvironment::get_max_workers ( ) const

inline

Get the value of the 'maxWorkers' attribute.

◆ get_network()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_network ( ) const

inline

Get the value of the 'network' attribute.

◆ get_num_workers()

int32 google_dataflow_api::RuntimeEnvironment::get_num_workers ( ) const

inline

Get the value of the 'numWorkers' attribute.

◆ get_service_account_email()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_service_account_email ( ) const

inline

Get the value of the 'serviceAccountEmail' attribute.

◆ get_subnetwork()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_subnetwork ( ) const

inline

Get the value of the 'subnetwork' attribute.

◆ get_temp_location()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_temp_location ( ) const

inline

Get the value of the 'tempLocation' attribute.

◆ get_worker_region()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_worker_region ( ) const

inline

Get the value of the 'workerRegion' attribute.

◆ get_worker_zone()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_worker_zone ( ) const

inline

Get the value of the 'workerZone' attribute.

◆ get_zone()

const StringPiece google_dataflow_api::RuntimeEnvironment::get_zone ( ) const

inline

Get the value of the 'zone' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::RuntimeEnvironment::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::RuntimeEnvironment

◆ has_additional_experiments()

bool google_dataflow_api::RuntimeEnvironment::has_additional_experiments ( ) const

inline

Determine if the 'additionalExperiments' attribute was set.

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

◆ has_additional_user_labels()

bool google_dataflow_api::RuntimeEnvironment::has_additional_user_labels ( ) const

inline

Determine if the 'additionalUserLabels' attribute was set.

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

◆ has_bypass_temp_dir_validation()

bool google_dataflow_api::RuntimeEnvironment::has_bypass_temp_dir_validation ( ) const

inline

Determine if the 'bypassTempDirValidation' attribute was set.

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

◆ has_ip_configuration()

bool google_dataflow_api::RuntimeEnvironment::has_ip_configuration ( ) const

inline

Determine if the 'ipConfiguration' attribute was set.

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

◆ has_kms_key_name()

bool google_dataflow_api::RuntimeEnvironment::has_kms_key_name ( ) const

inline

Determine if the 'kmsKeyName' attribute was set.

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

◆ has_machine_type()

bool google_dataflow_api::RuntimeEnvironment::has_machine_type ( ) const

inline

Determine if the 'machineType' attribute was set.

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

◆ has_max_workers()

bool google_dataflow_api::RuntimeEnvironment::has_max_workers ( ) const

inline

Determine if the 'maxWorkers' attribute was set.

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

◆ has_network()

bool google_dataflow_api::RuntimeEnvironment::has_network ( ) const

inline

Determine if the 'network' attribute was set.

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

◆ has_num_workers()

bool google_dataflow_api::RuntimeEnvironment::has_num_workers ( ) const

inline

Determine if the 'numWorkers' attribute was set.

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

◆ has_service_account_email()

bool google_dataflow_api::RuntimeEnvironment::has_service_account_email ( ) const

inline

Determine if the 'serviceAccountEmail' attribute was set.

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

◆ has_subnetwork()

bool google_dataflow_api::RuntimeEnvironment::has_subnetwork ( ) const

inline

Determine if the 'subnetwork' attribute was set.

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

◆ has_temp_location()

bool google_dataflow_api::RuntimeEnvironment::has_temp_location ( ) const

inline

Determine if the 'tempLocation' attribute was set.

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

◆ has_worker_region()

bool google_dataflow_api::RuntimeEnvironment::has_worker_region ( ) const

inline

Determine if the 'workerRegion' attribute was set.

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

◆ has_worker_zone()

bool google_dataflow_api::RuntimeEnvironment::has_worker_zone ( ) const

inline

Determine if the 'workerZone' attribute was set.

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

◆ has_zone()

bool google_dataflow_api::RuntimeEnvironment::has_zone ( ) const

inline

Determine if the 'zone' attribute was set.

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

◆ mutable_additionalExperiments()

client::JsonCppArray<string > google_dataflow_api::RuntimeEnvironment::mutable_additionalExperiments ( )

inline

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

Additional experiment flags for the job.

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

◆ mutable_additionalUserLabels()

client::JsonCppAssociativeArray<string > google_dataflow_api::RuntimeEnvironment::mutable_additionalUserLabels ( )

inline

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

Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page.

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

◆ New()

RuntimeEnvironment * google_dataflow_api::RuntimeEnvironment::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_bypass_temp_dir_validation()

void google_dataflow_api::RuntimeEnvironment::set_bypass_temp_dir_validation ( bool value )

inline

Change the 'bypassTempDirValidation' attribute.

Whether to bypass the safety checks for the job's temporary directory. Use with caution.

Parameters

[in] value The new value.

◆ set_ip_configuration()

void google_dataflow_api::RuntimeEnvironment::set_ip_configuration ( const StringPiece & value )

inline

Change the 'ipConfiguration' attribute.

Configuration for VM IPs.

Parameters

[in] value The new value.

◆ set_kms_key_name()

void google_dataflow_api::RuntimeEnvironment::set_kms_key_name ( const StringPiece & value )

inline

Change the 'kmsKeyName' attribute.

Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/.

Parameters

[in] value The new value.

◆ set_machine_type()

void google_dataflow_api::RuntimeEnvironment::set_machine_type ( const StringPiece & value )

inline

Change the 'machineType' attribute.

The machine type to use for the job. Defaults to the value from the template if not specified.

Parameters

[in] value The new value.

◆ set_max_workers()

void google_dataflow_api::RuntimeEnvironment::set_max_workers ( int32 value )

inline

Change the 'maxWorkers' attribute.

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

Parameters

[in] value The new value.

◆ set_network()

void google_dataflow_api::RuntimeEnvironment::set_network ( const StringPiece & value )

inline

Change the 'network' attribute.

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

Parameters

[in] value The new value.

◆ set_num_workers()

void google_dataflow_api::RuntimeEnvironment::set_num_workers ( int32 value )

inline

Change the 'numWorkers' attribute.

The initial number of Google Compute Engine instnaces for the job.

Parameters

[in] value The new value.

◆ set_service_account_email()

void google_dataflow_api::RuntimeEnvironment::set_service_account_email ( const StringPiece & value )

inline

Change the 'serviceAccountEmail' attribute.

The email address of the service account to run the job as.

Parameters

[in] value The new value.

◆ set_subnetwork()

void google_dataflow_api::RuntimeEnvironment::set_subnetwork ( const StringPiece & value )

inline

Change the 'subnetwork' attribute.

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

Parameters

[in] value The new value.

◆ set_temp_location()

void google_dataflow_api::RuntimeEnvironment::set_temp_location ( const StringPiece & value )

inline

Change the 'tempLocation' attribute.

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

Parameters

[in] value The new value.

◆ set_worker_region()

void google_dataflow_api::RuntimeEnvironment::set_worker_region ( const StringPiece & value )

inline

Change the 'workerRegion' attribute.

The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in

which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

Parameters

[in] value The new value.

◆ set_worker_zone()

void google_dataflow_api::RuntimeEnvironment::set_worker_zone ( const StringPiece & value )

inline

Change the 'workerZone' attribute.

The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in

which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both worker_zone and zone are set, worker_zone takes precedence.

Parameters

[in] value The new value.

◆ set_zone()

void google_dataflow_api::RuntimeEnvironment::set_zone ( const StringPiece & value )

inline

Change the 'zone' attribute.

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

Parameters

[in] value The new value.

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

google/dataflow_api/runtime_environment.h
google/dataflow_api/runtime_environment.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RuntimeEnvironment() [1/2]

◆ RuntimeEnvironment() [2/2]

◆ ~RuntimeEnvironment()

Member Function Documentation

◆ clear_additional_experiments()

◆ clear_additional_user_labels()

◆ clear_bypass_temp_dir_validation()

◆ clear_ip_configuration()

◆ clear_kms_key_name()

◆ clear_machine_type()

◆ clear_max_workers()

◆ clear_network()

◆ clear_num_workers()

◆ clear_service_account_email()

◆ clear_subnetwork()

◆ clear_temp_location()

◆ clear_worker_region()

◆ clear_worker_zone()

◆ clear_zone()

◆ get_additional_experiments()

◆ get_additional_user_labels()

◆ get_bypass_temp_dir_validation()

◆ get_ip_configuration()

◆ get_kms_key_name()

◆ get_machine_type()

◆ get_max_workers()

◆ get_network()

◆ get_num_workers()

◆ get_service_account_email()

◆ get_subnetwork()

◆ get_temp_location()

◆ get_worker_region()

◆ get_worker_zone()

◆ get_zone()

◆ GetTypeName()

◆ has_additional_experiments()

◆ has_additional_user_labels()

◆ has_bypass_temp_dir_validation()

◆ has_ip_configuration()

◆ has_kms_key_name()

◆ has_machine_type()

◆ has_max_workers()

◆ has_network()

◆ has_num_workers()

◆ has_service_account_email()

◆ has_subnetwork()

◆ has_temp_location()

◆ has_worker_region()

◆ has_worker_zone()

◆ has_zone()

◆ mutable_additionalExperiments()

◆ mutable_additionalUserLabels()

◆ New()

◆ set_bypass_temp_dir_validation()

◆ set_ip_configuration()

◆ set_kms_key_name()

◆ set_machine_type()

◆ set_max_workers()

◆ set_network()

◆ set_num_workers()

◆ set_service_account_email()

◆ set_subnetwork()

◆ set_temp_location()

◆ set_worker_region()

◆ set_worker_zone()

◆ set_zone()