Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::TaskRunnerSettings (v0.8.0)

Version 0.8.0

• 0.10.0 (latest)
• 0.9.1
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.4

Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::TaskRunnerSettings.

Taskrunner configuration settings.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#alsologtostderr

def alsologtostderr() -> ::Boolean

Returns

• (::Boolean) — Whether to also send taskrunner log info to stderr.

#alsologtostderr=

def alsologtostderr=(value) -> ::Boolean

Parameter

• value (::Boolean) — Whether to also send taskrunner log info to stderr.

Returns

• (::Boolean) — Whether to also send taskrunner log info to stderr.

#base_task_dir

def base_task_dir() -> ::String

Returns

• (::String) — The location on the worker for task-specific subdirectories.

#base_task_dir=

def base_task_dir=(value) -> ::String

Parameter

• value (::String) — The location on the worker for task-specific subdirectories.

Returns

• (::String) — The location on the worker for task-specific subdirectories.

#base_url

def base_url() -> ::String

Returns

• (::String) — 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/"

#base_url=

def base_url=(value) -> ::String

Parameter

• value (::String) — 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/"

Returns

• (::String) — 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/"

#commandlines_file_name

def commandlines_file_name() -> ::String

Returns

• (::String) — The file to store preprocessing commands in.

#commandlines_file_name=

def commandlines_file_name=(value) -> ::String

Parameter

• value (::String) — The file to store preprocessing commands in.

Returns

• (::String) — The file to store preprocessing commands in.

#continue_on_exception

def continue_on_exception() -> ::Boolean

Returns

• (::Boolean) — Whether to continue taskrunner if an exception is hit.

#continue_on_exception=

def continue_on_exception=(value) -> ::Boolean

Parameter

• value (::Boolean) — Whether to continue taskrunner if an exception is hit.

Returns

• (::Boolean) — Whether to continue taskrunner if an exception is hit.

#dataflow_api_version

def dataflow_api_version() -> ::String

Returns

• (::String) — The API version of endpoint, e.g. "v1b3"

#dataflow_api_version=

def dataflow_api_version=(value) -> ::String

Parameter

• value (::String) — The API version of endpoint, e.g. "v1b3"

Returns

• (::String) — The API version of endpoint, e.g. "v1b3"

#harness_command

def harness_command() -> ::String

Returns

• (::String) — The command to launch the worker harness.

#harness_command=

def harness_command=(value) -> ::String

Parameter

• value (::String) — The command to launch the worker harness.

Returns

• (::String) — The command to launch the worker harness.

#language_hint

def language_hint() -> ::String

Returns

• (::String) — The suggested backend language.

#language_hint=

def language_hint=(value) -> ::String

Parameter

• value (::String) — The suggested backend language.

Returns

• (::String) — The suggested backend language.

#log_dir

def log_dir() -> ::String

Returns

• (::String) — The directory on the VM to store logs.

#log_dir=

def log_dir=(value) -> ::String

Parameter

• value (::String) — The directory on the VM to store logs.

Returns

• (::String) — The directory on the VM to store logs.

#log_to_serialconsole

def log_to_serialconsole() -> ::Boolean

Returns

• (::Boolean) — Whether to send taskrunner log info to Google Compute Engine VM serial console.

#log_to_serialconsole=

def log_to_serialconsole=(value) -> ::Boolean

Parameter

• value (::Boolean) — Whether to send taskrunner log info to Google Compute Engine VM serial console.

Returns

• (::Boolean) — Whether to send taskrunner log info to Google Compute Engine VM serial console.

#log_upload_location

def log_upload_location() -> ::String

Returns

• (::String) — 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}

#log_upload_location=

def log_upload_location=(value) -> ::String

Parameter

• value (::String) — 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}

Returns

• (::String) — 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}

#oauth_scopes

def oauth_scopes() -> ::Array<::String>

Returns

• (::Array<::String>) — The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

#oauth_scopes=

def oauth_scopes=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

Returns

• (::Array<::String>) — The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

#parallel_worker_settings

def parallel_worker_settings() -> ::Google::Cloud::Dataflow::V1beta3::WorkerSettings

Returns

• (::Google::Cloud::Dataflow::V1beta3::WorkerSettings) — The settings to pass to the parallel worker harness.

#parallel_worker_settings=

def parallel_worker_settings=(value) -> ::Google::Cloud::Dataflow::V1beta3::WorkerSettings

Parameter

• value (::Google::Cloud::Dataflow::V1beta3::WorkerSettings) — The settings to pass to the parallel worker harness.

Returns

• (::Google::Cloud::Dataflow::V1beta3::WorkerSettings) — The settings to pass to the parallel worker harness.

#streaming_worker_main_class

def streaming_worker_main_class() -> ::String

Returns

• (::String) — The streaming worker main class name.

#streaming_worker_main_class=

def streaming_worker_main_class=(value) -> ::String

Parameter

• value (::String) — The streaming worker main class name.

Returns

• (::String) — The streaming worker main class name.

#task_group

def task_group() -> ::String

Returns

• (::String) — The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

#task_group=

def task_group=(value) -> ::String

Parameter

• value (::String) — The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

Returns

• (::String) — The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

#task_user

def task_user() -> ::String

Returns

• (::String) — The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

#task_user=

def task_user=(value) -> ::String

Parameter

• value (::String) — The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

Returns

• (::String) — The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

#temp_storage_prefix

def temp_storage_prefix() -> ::String

Returns

• (::String) — 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}

#temp_storage_prefix=

def temp_storage_prefix=(value) -> ::String

Parameter

• value (::String) — 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}

Returns

• (::String) — 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}

#vm_id

def vm_id() -> ::String

Returns

• (::String) — The ID string of the VM.

#vm_id=

def vm_id=(value) -> ::String

Parameter

• value (::String) — The ID string of the VM.

Returns

• (::String) — The ID string of the VM.

#workflow_file_name

def workflow_file_name() -> ::String

Returns

• (::String) — The file to store the workflow in.

#workflow_file_name=

def workflow_file_name=(value) -> ::String

Parameter

• value (::String) — The file to store the workflow in.

Returns

• (::String) — The file to store the workflow in.