Google Cloud Dataflow V1beta3 Client - Class TaskRunnerSettings (0.8.2)

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

Taskrunner configuration settings.

Generated from protobuf message google.dataflow.v1beta3.TaskRunnerSettings

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ task_user
string

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

↳ task_group
string

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

↳ oauth_scopes
array

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

↳ base_url
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/ "

↳ dataflow_api_version
string

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

↳ parallel_worker_settings
WorkerSettings

The settings to pass to the parallel worker harness.

↳ base_task_dir
string

The location on the worker for task-specific subdirectories.

↳ continue_on_exception
bool

Whether to continue taskrunner if an exception is hit.

↳ log_to_serialconsole
bool

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

↳ alsologtostderr
bool

Whether to also send taskrunner log info to stderr.

↳ log_upload_location
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_dir
string

The directory on the VM to store logs.

↳ temp_storage_prefix
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}

↳ harness_command
string

The command to launch the worker harness.

↳ workflow_file_name
string

The file to store the workflow in.

↳ commandlines_file_name
string

The file to store preprocessing commands in.

↳ vm_id
string

The ID string of the VM.

↳ language_hint
string

The suggested backend language.

↳ streaming_worker_main_class
string

The streaming worker main class name.

getTaskUser

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

Returns
Type
Description
string

setTaskUser

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTaskGroup

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

Returns
Type
Description
string

setTaskGroup

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOauthScopes

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

Returns
Type
Description

setOauthScopes

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

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getBaseUrl

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
Type
Description
string

setBaseUrl

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/ "

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDataflowApiVersion

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

Returns
Type
Description
string

setDataflowApiVersion

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getParallelWorkerSettings

The settings to pass to the parallel worker harness.

Returns
Type
Description

hasParallelWorkerSettings

clearParallelWorkerSettings

setParallelWorkerSettings

The settings to pass to the parallel worker harness.

Parameter
Name
Description
Returns
Type
Description
$this

getBaseTaskDir

The location on the worker for task-specific subdirectories.

Returns
Type
Description
string

setBaseTaskDir

The location on the worker for task-specific subdirectories.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getContinueOnException

Whether to continue taskrunner if an exception is hit.

Returns
Type
Description
bool

setContinueOnException

Whether to continue taskrunner if an exception is hit.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getLogToSerialconsole

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

Returns
Type
Description
bool

setLogToSerialconsole

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

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getAlsologtostderr

Whether to also send taskrunner log info to stderr.

Returns
Type
Description
bool

setAlsologtostderr

Whether to also send taskrunner log info to stderr.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getLogUploadLocation

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
Type
Description
string

setLogUploadLocation

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}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLogDir

The directory on the VM to store logs.

Returns
Type
Description
string

setLogDir

The directory on the VM to store logs.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTempStoragePrefix

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
Type
Description
string

setTempStoragePrefix

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}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getHarnessCommand

The command to launch the worker harness.

Returns
Type
Description
string

setHarnessCommand

The command to launch the worker harness.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getWorkflowFileName

The file to store the workflow in.

Returns
Type
Description
string

setWorkflowFileName

The file to store the workflow in.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCommandlinesFileName

The file to store preprocessing commands in.

Returns
Type
Description
string

setCommandlinesFileName

The file to store preprocessing commands in.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getVmId

The ID string of the VM.

Returns
Type
Description
string

setVmId

The ID string of the VM.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLanguageHint

The suggested backend language.

Returns
Type
Description
string

setLanguageHint

The suggested backend language.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getStreamingWorkerMainClass

The streaming worker main class name.

Returns
Type
Description
string

setStreamingWorkerMainClass

The streaming worker main class name.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: