Google Cloud Dataflow V1beta3 Client - Class TaskRunnerSettings (0.4.1)

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
NameDescription
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 Google\Cloud\Dataflow\V1beta3\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
TypeDescription
string

setTaskUser

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTaskGroup

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

Returns
TypeDescription
string

setTaskGroup

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOauthScopes

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setOauthScopes

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDataflowApiVersion

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

Returns
TypeDescription
string

setDataflowApiVersion

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParallelWorkerSettings

The settings to pass to the parallel worker harness.

Returns
TypeDescription
Google\Cloud\Dataflow\V1beta3\WorkerSettings|null

hasParallelWorkerSettings

clearParallelWorkerSettings

setParallelWorkerSettings

The settings to pass to the parallel worker harness.

Parameter
NameDescription
var Google\Cloud\Dataflow\V1beta3\WorkerSettings
Returns
TypeDescription
$this

getBaseTaskDir

The location on the worker for task-specific subdirectories.

Returns
TypeDescription
string

setBaseTaskDir

The location on the worker for task-specific subdirectories.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getContinueOnException

Whether to continue taskrunner if an exception is hit.

Returns
TypeDescription
bool

setContinueOnException

Whether to continue taskrunner if an exception is hit.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getLogToSerialconsole

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

Returns
TypeDescription
bool

setLogToSerialconsole

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAlsologtostderr

Whether to also send taskrunner log info to stderr.

Returns
TypeDescription
bool

setAlsologtostderr

Whether to also send taskrunner log info to stderr.

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getLogDir

The directory on the VM to store logs.

Returns
TypeDescription
string

setLogDir

The directory on the VM to store logs.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getHarnessCommand

The command to launch the worker harness.

Returns
TypeDescription
string

setHarnessCommand

The command to launch the worker harness.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWorkflowFileName

The file to store the workflow in.

Returns
TypeDescription
string

setWorkflowFileName

The file to store the workflow in.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCommandlinesFileName

The file to store preprocessing commands in.

Returns
TypeDescription
string

setCommandlinesFileName

The file to store preprocessing commands in.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVmId

The ID string of the VM.

Returns
TypeDescription
string

setVmId

The ID string of the VM.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLanguageHint

The suggested backend language.

Returns
TypeDescription
string

setLanguageHint

The suggested backend language.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStreamingWorkerMainClass

The streaming worker main class name.

Returns
TypeDescription
string

setStreamingWorkerMainClass

The streaming worker main class name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this