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

#include <task_runner_settings.h>

Inheritance diagram for google_dataflow_api::TaskRunnerSettings:

Public Member Functions

 TaskRunnerSettings (const Json::Value &storage)
 
 TaskRunnerSettings (Json::Value *storage)
 
virtual ~TaskRunnerSettings ()
 
const StringPiece GetTypeName () const
 
bool has_alsologtostderr () const
 
void clear_alsologtostderr ()
 
bool get_alsologtostderr () const
 
void set_alsologtostderr (bool value)
 
bool has_base_task_dir () const
 
void clear_base_task_dir ()
 
const StringPiece get_base_task_dir () const
 
void set_base_task_dir (const StringPiece &value)
 
bool has_base_url () const
 
void clear_base_url ()
 
const StringPiece get_base_url () const
 
void set_base_url (const StringPiece &value)
 
bool has_commandlines_file_name () const
 
void clear_commandlines_file_name ()
 
const StringPiece get_commandlines_file_name () const
 
void set_commandlines_file_name (const StringPiece &value)
 
bool has_continue_on_exception () const
 
void clear_continue_on_exception ()
 
bool get_continue_on_exception () const
 
void set_continue_on_exception (bool value)
 
bool has_dataflow_api_version () const
 
void clear_dataflow_api_version ()
 
const StringPiece get_dataflow_api_version () const
 
void set_dataflow_api_version (const StringPiece &value)
 
bool has_harness_command () const
 
void clear_harness_command ()
 
const StringPiece get_harness_command () const
 
void set_harness_command (const StringPiece &value)
 
bool has_language_hint () const
 
void clear_language_hint ()
 
const StringPiece get_language_hint () const
 
void set_language_hint (const StringPiece &value)
 
bool has_log_dir () const
 
void clear_log_dir ()
 
const StringPiece get_log_dir () const
 
void set_log_dir (const StringPiece &value)
 
bool has_log_to_serialconsole () const
 
void clear_log_to_serialconsole ()
 
bool get_log_to_serialconsole () const
 
void set_log_to_serialconsole (bool value)
 
bool has_log_upload_location () const
 
void clear_log_upload_location ()
 
const StringPiece get_log_upload_location () const
 
void set_log_upload_location (const StringPiece &value)
 
bool has_oauth_scopes () const
 
void clear_oauth_scopes ()
 
const client::JsonCppArray< string > get_oauth_scopes () const
 
client::JsonCppArray< string > mutable_oauthScopes ()
 
bool has_parallel_worker_settings () const
 
void clear_parallel_worker_settings ()
 
const WorkerSettings get_parallel_worker_settings () const
 
WorkerSettings mutable_parallelWorkerSettings ()
 
bool has_streaming_worker_main_class () const
 
void clear_streaming_worker_main_class ()
 
const StringPiece get_streaming_worker_main_class () const
 
void set_streaming_worker_main_class (const StringPiece &value)
 
bool has_task_group () const
 
void clear_task_group ()
 
const StringPiece get_task_group () const
 
void set_task_group (const StringPiece &value)
 
bool has_task_user () const
 
void clear_task_user ()
 
const StringPiece get_task_user () const
 
void set_task_user (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_vm_id () const
 
void clear_vm_id ()
 
const StringPiece get_vm_id () const
 
void set_vm_id (const StringPiece &value)
 
bool has_workflow_file_name () const
 
void clear_workflow_file_name ()
 
const StringPiece get_workflow_file_name () const
 
void set_workflow_file_name (const StringPiece &value)
 

Static Public Member Functions

static TaskRunnerSettingsNew ()
 

Detailed Description

Taskrunner configuration settings.

Constructor & Destructor Documentation

◆ TaskRunnerSettings() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ TaskRunnerSettings() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~TaskRunnerSettings()

google_dataflow_api::TaskRunnerSettings::~TaskRunnerSettings ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_alsologtostderr()

void google_dataflow_api::TaskRunnerSettings::clear_alsologtostderr ( )
inline

Clears the 'alsologtostderr' attribute.

◆ clear_base_task_dir()

void google_dataflow_api::TaskRunnerSettings::clear_base_task_dir ( )
inline

Clears the 'baseTaskDir' attribute.

◆ clear_base_url()

void google_dataflow_api::TaskRunnerSettings::clear_base_url ( )
inline

Clears the 'baseUrl' attribute.

◆ clear_commandlines_file_name()

void google_dataflow_api::TaskRunnerSettings::clear_commandlines_file_name ( )
inline

Clears the 'commandlinesFileName' attribute.

◆ clear_continue_on_exception()

void google_dataflow_api::TaskRunnerSettings::clear_continue_on_exception ( )
inline

Clears the 'continueOnException' attribute.

◆ clear_dataflow_api_version()

void google_dataflow_api::TaskRunnerSettings::clear_dataflow_api_version ( )
inline

Clears the 'dataflowApiVersion' attribute.

◆ clear_harness_command()

void google_dataflow_api::TaskRunnerSettings::clear_harness_command ( )
inline

Clears the 'harnessCommand' attribute.

◆ clear_language_hint()

void google_dataflow_api::TaskRunnerSettings::clear_language_hint ( )
inline

Clears the 'languageHint' attribute.

◆ clear_log_dir()

void google_dataflow_api::TaskRunnerSettings::clear_log_dir ( )
inline

Clears the 'logDir' attribute.

◆ clear_log_to_serialconsole()

void google_dataflow_api::TaskRunnerSettings::clear_log_to_serialconsole ( )
inline

Clears the 'logToSerialconsole' attribute.

◆ clear_log_upload_location()

void google_dataflow_api::TaskRunnerSettings::clear_log_upload_location ( )
inline

Clears the 'logUploadLocation' attribute.

◆ clear_oauth_scopes()

void google_dataflow_api::TaskRunnerSettings::clear_oauth_scopes ( )
inline

Clears the 'oauthScopes' attribute.

◆ clear_parallel_worker_settings()

void google_dataflow_api::TaskRunnerSettings::clear_parallel_worker_settings ( )
inline

Clears the 'parallelWorkerSettings' attribute.

◆ clear_streaming_worker_main_class()

void google_dataflow_api::TaskRunnerSettings::clear_streaming_worker_main_class ( )
inline

Clears the 'streamingWorkerMainClass' attribute.

◆ clear_task_group()

void google_dataflow_api::TaskRunnerSettings::clear_task_group ( )
inline

Clears the 'taskGroup' attribute.

◆ clear_task_user()

void google_dataflow_api::TaskRunnerSettings::clear_task_user ( )
inline

Clears the 'taskUser' attribute.

◆ clear_temp_storage_prefix()

void google_dataflow_api::TaskRunnerSettings::clear_temp_storage_prefix ( )
inline

Clears the 'tempStoragePrefix' attribute.

◆ clear_vm_id()

void google_dataflow_api::TaskRunnerSettings::clear_vm_id ( )
inline

Clears the 'vmId' attribute.

◆ clear_workflow_file_name()

void google_dataflow_api::TaskRunnerSettings::clear_workflow_file_name ( )
inline

Clears the 'workflowFileName' attribute.

◆ get_alsologtostderr()

bool google_dataflow_api::TaskRunnerSettings::get_alsologtostderr ( ) const
inline

Get the value of the 'alsologtostderr' attribute.

◆ get_base_task_dir()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_base_task_dir ( ) const
inline

Get the value of the 'baseTaskDir' attribute.

◆ get_base_url()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_base_url ( ) const
inline

Get the value of the 'baseUrl' attribute.

◆ get_commandlines_file_name()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_commandlines_file_name ( ) const
inline

Get the value of the 'commandlinesFileName' attribute.

◆ get_continue_on_exception()

bool google_dataflow_api::TaskRunnerSettings::get_continue_on_exception ( ) const
inline

Get the value of the 'continueOnException' attribute.

◆ get_dataflow_api_version()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_dataflow_api_version ( ) const
inline

Get the value of the 'dataflowApiVersion' attribute.

◆ get_harness_command()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_harness_command ( ) const
inline

Get the value of the 'harnessCommand' attribute.

◆ get_language_hint()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_language_hint ( ) const
inline

Get the value of the 'languageHint' attribute.

◆ get_log_dir()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_log_dir ( ) const
inline

Get the value of the 'logDir' attribute.

◆ get_log_to_serialconsole()

bool google_dataflow_api::TaskRunnerSettings::get_log_to_serialconsole ( ) const
inline

Get the value of the 'logToSerialconsole' attribute.

◆ get_log_upload_location()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_log_upload_location ( ) const
inline

Get the value of the 'logUploadLocation' attribute.

◆ get_oauth_scopes()

const client::JsonCppArray<string > google_dataflow_api::TaskRunnerSettings::get_oauth_scopes ( ) const
inline

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

◆ get_parallel_worker_settings()

const WorkerSettings google_dataflow_api::TaskRunnerSettings::get_parallel_worker_settings ( ) const

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

◆ get_streaming_worker_main_class()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_streaming_worker_main_class ( ) const
inline

Get the value of the 'streamingWorkerMainClass' attribute.

◆ get_task_group()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_task_group ( ) const
inline

Get the value of the 'taskGroup' attribute.

◆ get_task_user()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_task_user ( ) const
inline

Get the value of the 'taskUser' attribute.

◆ get_temp_storage_prefix()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_temp_storage_prefix ( ) const
inline

Get the value of the 'tempStoragePrefix' attribute.

◆ get_vm_id()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_vm_id ( ) const
inline

Get the value of the 'vmId' attribute.

◆ get_workflow_file_name()

const StringPiece google_dataflow_api::TaskRunnerSettings::get_workflow_file_name ( ) const
inline

Get the value of the 'workflowFileName' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::TaskRunnerSettings

◆ has_alsologtostderr()

bool google_dataflow_api::TaskRunnerSettings::has_alsologtostderr ( ) const
inline

Determine if the 'alsologtostderr' attribute was set.

Returns
true if the 'alsologtostderr' attribute was set.

◆ has_base_task_dir()

bool google_dataflow_api::TaskRunnerSettings::has_base_task_dir ( ) const
inline

Determine if the 'baseTaskDir' attribute was set.

Returns
true if the 'baseTaskDir' attribute was set.

◆ has_base_url()

bool google_dataflow_api::TaskRunnerSettings::has_base_url ( ) const
inline

Determine if the 'baseUrl' attribute was set.

Returns
true if the 'baseUrl' attribute was set.

◆ has_commandlines_file_name()

bool google_dataflow_api::TaskRunnerSettings::has_commandlines_file_name ( ) const
inline

Determine if the 'commandlinesFileName' attribute was set.

Returns
true if the 'commandlinesFileName' attribute was set.

◆ has_continue_on_exception()

bool google_dataflow_api::TaskRunnerSettings::has_continue_on_exception ( ) const
inline

Determine if the 'continueOnException' attribute was set.

Returns
true if the 'continueOnException' attribute was set.

◆ has_dataflow_api_version()

bool google_dataflow_api::TaskRunnerSettings::has_dataflow_api_version ( ) const
inline

Determine if the 'dataflowApiVersion' attribute was set.

Returns
true if the 'dataflowApiVersion' attribute was set.

◆ has_harness_command()

bool google_dataflow_api::TaskRunnerSettings::has_harness_command ( ) const
inline

Determine if the 'harnessCommand' attribute was set.

Returns
true if the 'harnessCommand' attribute was set.

◆ has_language_hint()

bool google_dataflow_api::TaskRunnerSettings::has_language_hint ( ) const
inline

Determine if the 'languageHint' attribute was set.

Returns
true if the 'languageHint' attribute was set.

◆ has_log_dir()

bool google_dataflow_api::TaskRunnerSettings::has_log_dir ( ) const
inline

Determine if the 'logDir' attribute was set.

Returns
true if the 'logDir' attribute was set.

◆ has_log_to_serialconsole()

bool google_dataflow_api::TaskRunnerSettings::has_log_to_serialconsole ( ) const
inline

Determine if the 'logToSerialconsole' attribute was set.

Returns
true if the 'logToSerialconsole' attribute was set.

◆ has_log_upload_location()

bool google_dataflow_api::TaskRunnerSettings::has_log_upload_location ( ) const
inline

Determine if the 'logUploadLocation' attribute was set.

Returns
true if the 'logUploadLocation' attribute was set.

◆ has_oauth_scopes()

bool google_dataflow_api::TaskRunnerSettings::has_oauth_scopes ( ) const
inline

Determine if the 'oauthScopes' attribute was set.

Returns
true if the 'oauthScopes' attribute was set.

◆ has_parallel_worker_settings()

bool google_dataflow_api::TaskRunnerSettings::has_parallel_worker_settings ( ) const
inline

Determine if the 'parallelWorkerSettings' attribute was set.

Returns
true if the 'parallelWorkerSettings' attribute was set.

◆ has_streaming_worker_main_class()

bool google_dataflow_api::TaskRunnerSettings::has_streaming_worker_main_class ( ) const
inline

Determine if the 'streamingWorkerMainClass' attribute was set.

Returns
true if the 'streamingWorkerMainClass' attribute was set.

◆ has_task_group()

bool google_dataflow_api::TaskRunnerSettings::has_task_group ( ) const
inline

Determine if the 'taskGroup' attribute was set.

Returns
true if the 'taskGroup' attribute was set.

◆ has_task_user()

bool google_dataflow_api::TaskRunnerSettings::has_task_user ( ) const
inline

Determine if the 'taskUser' attribute was set.

Returns
true if the 'taskUser' attribute was set.

◆ has_temp_storage_prefix()

bool google_dataflow_api::TaskRunnerSettings::has_temp_storage_prefix ( ) const
inline

Determine if the 'tempStoragePrefix' attribute was set.

Returns
true if the 'tempStoragePrefix' attribute was set.

◆ has_vm_id()

bool google_dataflow_api::TaskRunnerSettings::has_vm_id ( ) const
inline

Determine if the 'vmId' attribute was set.

Returns
true if the 'vmId' attribute was set.

◆ has_workflow_file_name()

bool google_dataflow_api::TaskRunnerSettings::has_workflow_file_name ( ) const
inline

Determine if the 'workflowFileName' attribute was set.

Returns
true if the 'workflowFileName' attribute was set.

◆ mutable_oauthScopes()

client::JsonCppArray<string > google_dataflow_api::TaskRunnerSettings::mutable_oauthScopes ( )
inline

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

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

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

◆ mutable_parallelWorkerSettings()

WorkerSettings google_dataflow_api::TaskRunnerSettings::mutable_parallelWorkerSettings ( )

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

The settings to pass to the parallel worker harness.

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

◆ New()

TaskRunnerSettings * google_dataflow_api::TaskRunnerSettings::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_alsologtostderr()

void google_dataflow_api::TaskRunnerSettings::set_alsologtostderr ( bool  value)
inline

Change the 'alsologtostderr' attribute.

Whether to also send taskrunner log info to stderr.

Parameters
[in]valueThe new value.

◆ set_base_task_dir()

void google_dataflow_api::TaskRunnerSettings::set_base_task_dir ( const StringPiece &  value)
inline

Change the 'baseTaskDir' attribute.

The location on the worker for task-specific subdirectories.

Parameters
[in]valueThe new value.

◆ set_base_url()

void google_dataflow_api::TaskRunnerSettings::set_base_url ( const StringPiece &  value)
inline

Change the 'baseUrl' attribute.

The base URL for the taskrunner to use when 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]valueThe new value.

◆ set_commandlines_file_name()

void google_dataflow_api::TaskRunnerSettings::set_commandlines_file_name ( const StringPiece &  value)
inline

Change the 'commandlinesFileName' attribute.

The file to store preprocessing commands in.

Parameters
[in]valueThe new value.

◆ set_continue_on_exception()

void google_dataflow_api::TaskRunnerSettings::set_continue_on_exception ( bool  value)
inline

Change the 'continueOnException' attribute.

Whether to continue taskrunner if an exception is hit.

Parameters
[in]valueThe new value.

◆ set_dataflow_api_version()

void google_dataflow_api::TaskRunnerSettings::set_dataflow_api_version ( const StringPiece &  value)
inline

Change the 'dataflowApiVersion' attribute.

The API version of endpoint, e.g. "v1b3".

Parameters
[in]valueThe new value.

◆ set_harness_command()

void google_dataflow_api::TaskRunnerSettings::set_harness_command ( const StringPiece &  value)
inline

Change the 'harnessCommand' attribute.

The command to launch the worker harness.

Parameters
[in]valueThe new value.

◆ set_language_hint()

void google_dataflow_api::TaskRunnerSettings::set_language_hint ( const StringPiece &  value)
inline

Change the 'languageHint' attribute.

The suggested backend language.

Parameters
[in]valueThe new value.

◆ set_log_dir()

void google_dataflow_api::TaskRunnerSettings::set_log_dir ( const StringPiece &  value)
inline

Change the 'logDir' attribute.

The directory on the VM to store logs.

Parameters
[in]valueThe new value.

◆ set_log_to_serialconsole()

void google_dataflow_api::TaskRunnerSettings::set_log_to_serialconsole ( bool  value)
inline

Change the 'logToSerialconsole' attribute.

Whether to send taskrunner log info to Google Compute Engine VM serial console.

Parameters
[in]valueThe new value.

◆ set_log_upload_location()

void google_dataflow_api::TaskRunnerSettings::set_log_upload_location ( const StringPiece &  value)
inline

Change the 'logUploadLocation' attribute.

Indicates where to put logs. If this is not specified, the logs will not be uploaded.

The supported resource type is:

Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}.

Parameters
[in]valueThe new value.

◆ set_streaming_worker_main_class()

void google_dataflow_api::TaskRunnerSettings::set_streaming_worker_main_class ( const StringPiece &  value)
inline

Change the 'streamingWorkerMainClass' attribute.

The streaming worker main class name.

Parameters
[in]valueThe new value.

◆ set_task_group()

void google_dataflow_api::TaskRunnerSettings::set_task_group ( const StringPiece &  value)
inline

Change the 'taskGroup' attribute.

The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

Parameters
[in]valueThe new value.

◆ set_task_user()

void google_dataflow_api::TaskRunnerSettings::set_task_user ( const StringPiece &  value)
inline

Change the 'taskUser' attribute.

The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

Parameters
[in]valueThe new value.

◆ set_temp_storage_prefix()

void google_dataflow_api::TaskRunnerSettings::set_temp_storage_prefix ( const StringPiece &  value)
inline

Change the 'tempStoragePrefix' attribute.

The prefix of the resources the taskrunner 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]valueThe new value.

◆ set_vm_id()

void google_dataflow_api::TaskRunnerSettings::set_vm_id ( const StringPiece &  value)
inline

Change the 'vmId' attribute.

The ID string of the VM.

Parameters
[in]valueThe new value.

◆ set_workflow_file_name()

void google_dataflow_api::TaskRunnerSettings::set_workflow_file_name ( const StringPiece &  value)
inline

Change the 'workflowFileName' attribute.

The file to store the workflow in.

Parameters
[in]valueThe new value.

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