#include <environment.h>

Inheritance diagram for google_dataflow_api::Environment:

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

	Environment (Json::Value *storage)

virtual	~Environment ()

const StringPiece	GetTypeName () const

bool	has_cluster_manager_api_service () const

void	clear_cluster_manager_api_service ()

const StringPiece	get_cluster_manager_api_service () const

void	set_cluster_manager_api_service (const StringPiece &value)

bool	has_dataset () const

void	clear_dataset ()

const StringPiece	get_dataset () const

void	set_dataset (const StringPiece &value)

bool	has_experiments () const

void	clear_experiments ()

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

client::JsonCppArray< string >	mutable_experiments ()

bool	has_flex_resource_scheduling_goal () const

void	clear_flex_resource_scheduling_goal ()

const StringPiece	get_flex_resource_scheduling_goal () const

void	set_flex_resource_scheduling_goal (const StringPiece &value)

bool	has_internal_experiments () const

void	clear_internal_experiments ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_internal_experiments () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_internalExperiments ()

bool	has_sdk_pipeline_options () const

void	clear_sdk_pipeline_options ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_sdk_pipeline_options () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_sdkPipelineOptions ()

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_service_kms_key_name () const

void	clear_service_kms_key_name ()

const StringPiece	get_service_kms_key_name () const

void	set_service_kms_key_name (const StringPiece &value)

bool	has_temp_storage_prefix () const

void	clear_temp_storage_prefix ()

const StringPiece	get_temp_storage_prefix () const

void	set_temp_storage_prefix (const StringPiece &value)

bool	has_user_agent () const

void	clear_user_agent ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_user_agent () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_userAgent ()

bool	has_version () const

void	clear_version ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_version () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_version ()

bool	has_worker_pools () const

void	clear_worker_pools ()

const client::JsonCppArray< WorkerPool >	get_worker_pools () const

client::JsonCppArray< WorkerPool >	mutable_workerPools ()

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)

Static Public Member Functions
static Environment *	New ()

Detailed Description

Describes the environment in which a Dataflow Job runs.

Constructor & Destructor Documentation

◆ Environment() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Environment() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Environment()

google_dataflow_api::Environment::~Environment ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_cluster_manager_api_service()

void google_dataflow_api::Environment::clear_cluster_manager_api_service ( )

inline

Clears the 'clusterManagerApiService' attribute.

◆ clear_dataset()

void google_dataflow_api::Environment::clear_dataset ( )

inline

Clears the 'dataset' attribute.

◆ clear_experiments()

void google_dataflow_api::Environment::clear_experiments ( )

inline

Clears the 'experiments' attribute.

◆ clear_flex_resource_scheduling_goal()

void google_dataflow_api::Environment::clear_flex_resource_scheduling_goal ( )

inline

Clears the 'flexResourceSchedulingGoal' attribute.

◆ clear_internal_experiments()

void google_dataflow_api::Environment::clear_internal_experiments ( )

inline

Clears the 'internalExperiments' attribute.

◆ clear_sdk_pipeline_options()

void google_dataflow_api::Environment::clear_sdk_pipeline_options ( )

inline

Clears the 'sdkPipelineOptions' attribute.

◆ clear_service_account_email()

void google_dataflow_api::Environment::clear_service_account_email ( )

inline

Clears the 'serviceAccountEmail' attribute.

◆ clear_service_kms_key_name()

void google_dataflow_api::Environment::clear_service_kms_key_name ( )

inline

Clears the 'serviceKmsKeyName' attribute.

◆ clear_temp_storage_prefix()

void google_dataflow_api::Environment::clear_temp_storage_prefix ( )

inline

Clears the 'tempStoragePrefix' attribute.

◆ clear_user_agent()

void google_dataflow_api::Environment::clear_user_agent ( )

inline

Clears the 'userAgent' attribute.

◆ clear_version()

void google_dataflow_api::Environment::clear_version ( )

inline

Clears the 'version' attribute.

◆ clear_worker_pools()

void google_dataflow_api::Environment::clear_worker_pools ( )

inline

Clears the 'workerPools' attribute.

◆ clear_worker_region()

void google_dataflow_api::Environment::clear_worker_region ( )

inline

Clears the 'workerRegion' attribute.

◆ clear_worker_zone()

void google_dataflow_api::Environment::clear_worker_zone ( )

inline

Clears the 'workerZone' attribute.

◆ get_cluster_manager_api_service()

const StringPiece google_dataflow_api::Environment::get_cluster_manager_api_service ( ) const

inline

Get the value of the 'clusterManagerApiService' attribute.

◆ get_dataset()

const StringPiece google_dataflow_api::Environment::get_dataset ( ) const

inline

Get the value of the 'dataset' attribute.

◆ get_experiments()

const client::JsonCppArray<string > google_dataflow_api::Environment::get_experiments ( ) const

inline

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

◆ get_flex_resource_scheduling_goal()

const StringPiece google_dataflow_api::Environment::get_flex_resource_scheduling_goal ( ) const

inline

Get the value of the 'flexResourceSchedulingGoal' attribute.

◆ get_internal_experiments()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::get_internal_experiments ( ) const

inline

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

◆ get_sdk_pipeline_options()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::get_sdk_pipeline_options ( ) const

inline

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

◆ get_service_account_email()

const StringPiece google_dataflow_api::Environment::get_service_account_email ( ) const

inline

Get the value of the 'serviceAccountEmail' attribute.

◆ get_service_kms_key_name()

const StringPiece google_dataflow_api::Environment::get_service_kms_key_name ( ) const

inline

Get the value of the 'serviceKmsKeyName' attribute.

◆ get_temp_storage_prefix()

const StringPiece google_dataflow_api::Environment::get_temp_storage_prefix ( ) const

inline

Get the value of the 'tempStoragePrefix' attribute.

◆ get_user_agent()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::get_user_agent ( ) const

inline

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

◆ get_version()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::get_version ( ) const

inline

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

◆ get_worker_pools()

const client::JsonCppArray<WorkerPool > google_dataflow_api::Environment::get_worker_pools ( ) const

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

◆ get_worker_region()

const StringPiece google_dataflow_api::Environment::get_worker_region ( ) const

inline

Get the value of the 'workerRegion' attribute.

◆ get_worker_zone()

const StringPiece google_dataflow_api::Environment::get_worker_zone ( ) const

inline

Get the value of the 'workerZone' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::Environment::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::Environment

◆ has_cluster_manager_api_service()

bool google_dataflow_api::Environment::has_cluster_manager_api_service ( ) const

inline

Determine if the 'clusterManagerApiService' attribute was set.

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

◆ has_dataset()

bool google_dataflow_api::Environment::has_dataset ( ) const

inline

Determine if the 'dataset' attribute was set.

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

◆ has_experiments()

bool google_dataflow_api::Environment::has_experiments ( ) const

inline

Determine if the 'experiments' attribute was set.

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

◆ has_flex_resource_scheduling_goal()

bool google_dataflow_api::Environment::has_flex_resource_scheduling_goal ( ) const

inline

Determine if the 'flexResourceSchedulingGoal' attribute was set.

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

◆ has_internal_experiments()

bool google_dataflow_api::Environment::has_internal_experiments ( ) const

inline

Determine if the 'internalExperiments' attribute was set.

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

◆ has_sdk_pipeline_options()

bool google_dataflow_api::Environment::has_sdk_pipeline_options ( ) const

inline

Determine if the 'sdkPipelineOptions' attribute was set.

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

◆ has_service_account_email()

bool google_dataflow_api::Environment::has_service_account_email ( ) const

inline

Determine if the 'serviceAccountEmail' attribute was set.

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

◆ has_service_kms_key_name()

bool google_dataflow_api::Environment::has_service_kms_key_name ( ) const

inline

Determine if the 'serviceKmsKeyName' attribute was set.

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

◆ has_temp_storage_prefix()

bool google_dataflow_api::Environment::has_temp_storage_prefix ( ) const

inline

Determine if the 'tempStoragePrefix' attribute was set.

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

◆ has_user_agent()

bool google_dataflow_api::Environment::has_user_agent ( ) const

inline

Determine if the 'userAgent' attribute was set.

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

◆ has_version()

bool google_dataflow_api::Environment::has_version ( ) const

inline

Determine if the 'version' attribute was set.

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

◆ has_worker_pools()

bool google_dataflow_api::Environment::has_worker_pools ( ) const

inline

Determine if the 'workerPools' attribute was set.

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

◆ has_worker_region()

bool google_dataflow_api::Environment::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::Environment::has_worker_zone ( ) const

inline

Determine if the 'workerZone' attribute was set.

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

◆ mutable_experiments()

client::JsonCppArray<string > google_dataflow_api::Environment::mutable_experiments ( )

inline

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

The list of experiments to enable.

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

◆ mutable_internalExperiments()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::mutable_internalExperiments ( )

inline

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

Experimental settings.

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

◆ mutable_sdkPipelineOptions()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::mutable_sdkPipelineOptions ( )

inline

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

The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.

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

◆ mutable_userAgent()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::mutable_userAgent ( )

inline

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

A description of the process that generated the request.

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

◆ mutable_version()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::Environment::mutable_version ( )

inline

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

A structure describing which components and their versions of the service are required in order to run the job.

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

◆ mutable_workerPools()

client::JsonCppArray<WorkerPool > google_dataflow_api::Environment::mutable_workerPools ( )

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

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

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

◆ New()

Environment * google_dataflow_api::Environment::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_cluster_manager_api_service()

void google_dataflow_api::Environment::set_cluster_manager_api_service ( const StringPiece & value )

inline

Change the 'clusterManagerApiService' attribute.

The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".

Parameters

[in] value The new value.

◆ set_dataset()

void google_dataflow_api::Environment::set_dataset ( const StringPiece & value )

inline

Change the 'dataset' attribute.

The dataset for the current project where various workflow related tables are stored.

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}.

Parameters

[in] value The new value.

◆ set_flex_resource_scheduling_goal()

void google_dataflow_api::Environment::set_flex_resource_scheduling_goal ( const StringPiece & value )

inline

Change the 'flexResourceSchedulingGoal' attribute.

Which Flexible Resource Scheduling mode to run in.

Parameters

[in] value The new value.

◆ set_service_account_email()

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

inline

Change the 'serviceAccountEmail' attribute.

Identity to run virtual machines as. Defaults to the default account.

Parameters

[in] value The new value.

◆ set_service_kms_key_name()

void google_dataflow_api::Environment::set_service_kms_key_name ( const StringPiece & value )

inline

Change the 'serviceKmsKeyName' attribute.

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY.

Parameters

[in] value The new value.

◆ set_temp_storage_prefix()

void google_dataflow_api::Environment::set_temp_storage_prefix ( const StringPiece & value )

inline

Change the 'tempStoragePrefix' attribute.

The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}.

Parameters

[in] value The new value.

◆ set_worker_region()

void google_dataflow_api::Environment::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::Environment::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.

Parameters

[in] value The new value.

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

google/dataflow_api/environment.h
google/dataflow_api/environment.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Environment() [1/2]

◆ Environment() [2/2]

◆ ~Environment()

Member Function Documentation

◆ clear_cluster_manager_api_service()

◆ clear_dataset()

◆ clear_experiments()

◆ clear_flex_resource_scheduling_goal()

◆ clear_internal_experiments()

◆ clear_sdk_pipeline_options()

◆ clear_service_account_email()

◆ clear_service_kms_key_name()

◆ clear_temp_storage_prefix()

◆ clear_user_agent()

◆ clear_version()

◆ clear_worker_pools()

◆ clear_worker_region()

◆ clear_worker_zone()

◆ get_cluster_manager_api_service()

◆ get_dataset()

◆ get_experiments()

◆ get_flex_resource_scheduling_goal()

◆ get_internal_experiments()

◆ get_sdk_pipeline_options()

◆ get_service_account_email()

◆ get_service_kms_key_name()

◆ get_temp_storage_prefix()

◆ get_user_agent()

◆ get_version()

◆ get_worker_pools()

◆ get_worker_region()

◆ get_worker_zone()

◆ GetTypeName()

◆ has_cluster_manager_api_service()

◆ has_dataset()

◆ has_experiments()

◆ has_flex_resource_scheduling_goal()

◆ has_internal_experiments()

◆ has_sdk_pipeline_options()

◆ has_service_account_email()

◆ has_service_kms_key_name()

◆ has_temp_storage_prefix()

◆ has_user_agent()

◆ has_version()

◆ has_worker_pools()

◆ has_worker_region()

◆ has_worker_zone()

◆ mutable_experiments()

◆ mutable_internalExperiments()

◆ mutable_sdkPipelineOptions()

◆ mutable_userAgent()

◆ mutable_version()

◆ mutable_workerPools()

◆ New()

◆ set_cluster_manager_api_service()

◆ set_dataset()

◆ set_flex_resource_scheduling_goal()

◆ set_service_account_email()

◆ set_service_kms_key_name()

◆ set_temp_storage_prefix()

◆ set_worker_region()

◆ set_worker_zone()