#include <worker_settings.h>

Inheritance diagram for google_dataflow_api::WorkerSettings:

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

	WorkerSettings (Json::Value *storage)

virtual	~WorkerSettings ()

const StringPiece	GetTypeName () const

bool	has_base_url () const

void	clear_base_url ()

const StringPiece	get_base_url () const

void	set_base_url (const StringPiece &value)

bool	has_reporting_enabled () const

void	clear_reporting_enabled ()

bool	get_reporting_enabled () const

void	set_reporting_enabled (bool value)

bool	has_service_path () const

void	clear_service_path ()

const StringPiece	get_service_path () const

void	set_service_path (const StringPiece &value)

bool	has_shuffle_service_path () const

void	clear_shuffle_service_path ()

const StringPiece	get_shuffle_service_path () const

void	set_shuffle_service_path (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_worker_id () const

void	clear_worker_id ()

const StringPiece	get_worker_id () const

void	set_worker_id (const StringPiece &value)

Static Public Member Functions
static WorkerSettings *	New ()

Detailed Description

Provides data to pass through to the worker harness.

Constructor & Destructor Documentation

◆ WorkerSettings() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ WorkerSettings() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~WorkerSettings()

google_dataflow_api::WorkerSettings::~WorkerSettings ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_base_url()

void google_dataflow_api::WorkerSettings::clear_base_url ( )

inline

Clears the 'baseUrl' attribute.

◆ clear_reporting_enabled()

void google_dataflow_api::WorkerSettings::clear_reporting_enabled ( )

inline

Clears the 'reportingEnabled' attribute.

◆ clear_service_path()

void google_dataflow_api::WorkerSettings::clear_service_path ( )

inline

Clears the 'servicePath' attribute.

◆ clear_shuffle_service_path()

void google_dataflow_api::WorkerSettings::clear_shuffle_service_path ( )

inline

Clears the 'shuffleServicePath' attribute.

◆ clear_temp_storage_prefix()

void google_dataflow_api::WorkerSettings::clear_temp_storage_prefix ( )

inline

Clears the 'tempStoragePrefix' attribute.

◆ clear_worker_id()

void google_dataflow_api::WorkerSettings::clear_worker_id ( )

inline

Clears the 'workerId' attribute.

◆ get_base_url()

const StringPiece google_dataflow_api::WorkerSettings::get_base_url ( ) const

inline

Get the value of the 'baseUrl' attribute.

◆ get_reporting_enabled()

bool google_dataflow_api::WorkerSettings::get_reporting_enabled ( ) const

inline

Get the value of the 'reportingEnabled' attribute.

◆ get_service_path()

const StringPiece google_dataflow_api::WorkerSettings::get_service_path ( ) const

inline

Get the value of the 'servicePath' attribute.

◆ get_shuffle_service_path()

const StringPiece google_dataflow_api::WorkerSettings::get_shuffle_service_path ( ) const

inline

Get the value of the 'shuffleServicePath' attribute.

◆ get_temp_storage_prefix()

const StringPiece google_dataflow_api::WorkerSettings::get_temp_storage_prefix ( ) const

inline

Get the value of the 'tempStoragePrefix' attribute.

◆ get_worker_id()

const StringPiece google_dataflow_api::WorkerSettings::get_worker_id ( ) const

inline

Get the value of the 'workerId' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::WorkerSettings::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::WorkerSettings

◆ has_base_url()

bool google_dataflow_api::WorkerSettings::has_base_url ( ) const

inline

Determine if the 'baseUrl' attribute was set.

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

◆ has_reporting_enabled()

bool google_dataflow_api::WorkerSettings::has_reporting_enabled ( ) const

inline

Determine if the 'reportingEnabled' attribute was set.

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

◆ has_service_path()

bool google_dataflow_api::WorkerSettings::has_service_path ( ) const

inline

Determine if the 'servicePath' attribute was set.

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

◆ has_shuffle_service_path()

bool google_dataflow_api::WorkerSettings::has_shuffle_service_path ( ) const

inline

Determine if the 'shuffleServicePath' attribute was set.

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

◆ has_temp_storage_prefix()

bool google_dataflow_api::WorkerSettings::has_temp_storage_prefix ( ) const

inline

Determine if the 'tempStoragePrefix' attribute was set.

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

◆ has_worker_id()

bool google_dataflow_api::WorkerSettings::has_worker_id ( ) const

inline

Determine if the 'workerId' attribute was set.

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

◆ New()

WorkerSettings * google_dataflow_api::WorkerSettings::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_base_url()

void google_dataflow_api::WorkerSettings::set_base_url ( const StringPiece & value )

inline

Change the 'baseUrl' attribute.

The base URL for accessing Google Cloud APIs.

When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators".

If not specified, the default value is "http://www.googleapis.com/".

Parameters

[in] value The new value.

◆ set_reporting_enabled()

void google_dataflow_api::WorkerSettings::set_reporting_enabled ( bool value )

inline

Change the 'reportingEnabled' attribute.

Whether to send work progress updates to the service.

Parameters

[in] value The new value.

◆ set_service_path()

void google_dataflow_api::WorkerSettings::set_service_path ( const StringPiece & value )

inline

Change the 'servicePath' attribute.

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

Parameters

[in] value The new value.

◆ set_shuffle_service_path()

void google_dataflow_api::WorkerSettings::set_shuffle_service_path ( const StringPiece & value )

inline

Change the 'shuffleServicePath' attribute.

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

Parameters

[in] value The new value.

◆ set_temp_storage_prefix()

void google_dataflow_api::WorkerSettings::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 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_id()

void google_dataflow_api::WorkerSettings::set_worker_id ( const StringPiece & value )

inline

Change the 'workerId' attribute.

The ID of the worker running this pipeline.

Parameters

[in] value The new value.

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

google/dataflow_api/worker_settings.h
google/dataflow_api/worker_settings.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WorkerSettings() [1/2]

◆ WorkerSettings() [2/2]

◆ ~WorkerSettings()

Member Function Documentation

◆ clear_base_url()

◆ clear_reporting_enabled()

◆ clear_service_path()

◆ clear_shuffle_service_path()

◆ clear_temp_storage_prefix()

◆ clear_worker_id()

◆ get_base_url()

◆ get_reporting_enabled()

◆ get_service_path()

◆ get_shuffle_service_path()

◆ get_temp_storage_prefix()

◆ get_worker_id()

◆ GetTypeName()

◆ has_base_url()

◆ has_reporting_enabled()

◆ has_service_path()

◆ has_shuffle_service_path()

◆ has_temp_storage_prefix()

◆ has_worker_id()

◆ New()

◆ set_base_url()

◆ set_reporting_enabled()

◆ set_service_path()

◆ set_shuffle_service_path()

◆ set_temp_storage_prefix()

◆ set_worker_id()