Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class WorkerSettings.
Provides data to pass through to the worker harness.
Generated from protobuf message google.dataflow.v1beta3.WorkerSettings
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ base_url |
string
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/" |
↳ reporting_enabled |
bool
Whether to send work progress updates to the service. |
↳ service_path |
string
The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
↳ shuffle_service_path |
string
The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
↳ worker_id |
string
The ID of the worker running this pipeline. |
↳ temp_storage_prefix |
string
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} |
getBaseUrl
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/"
| Returns | |
|---|---|
| Type | Description |
string | |
setBaseUrl
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/"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReportingEnabled
Whether to send work progress updates to the service.
| Returns | |
|---|---|
| Type | Description |
bool | |
setReportingEnabled
Whether to send work progress updates to the service.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServicePath
The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
| Returns | |
|---|---|
| Type | Description |
string | |
setServicePath
The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getShuffleServicePath
The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
| Returns | |
|---|---|
| Type | Description |
string | |
setShuffleServicePath
The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWorkerId
The ID of the worker running this pipeline.
| Returns | |
|---|---|
| Type | Description |
string | |
setWorkerId
The ID of the worker running this pipeline.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTempStoragePrefix
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}
| Returns | |
|---|---|
| Type | Description |
string | |
setTempStoragePrefix
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |