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 messagegoogle.dataflow.v1beta3.WorkerSettings
Namespace
Google \ Cloud \ Dataflow \ V1beta3
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}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataflow V1beta3 Client - Class WorkerSettings (0.8.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.2 (latest)](/php/docs/reference/cloud-dataflow/latest/V1beta3.WorkerSettings)\n- [0.8.1](/php/docs/reference/cloud-dataflow/0.8.1/V1beta3.WorkerSettings)\n- [0.7.1](/php/docs/reference/cloud-dataflow/0.7.1/V1beta3.WorkerSettings)\n- [0.6.6](/php/docs/reference/cloud-dataflow/0.6.6/V1beta3.WorkerSettings)\n- [0.5.1](/php/docs/reference/cloud-dataflow/0.5.1/V1beta3.WorkerSettings)\n- [0.4.1](/php/docs/reference/cloud-dataflow/0.4.1/V1beta3.WorkerSettings)\n- [0.3.10](/php/docs/reference/cloud-dataflow/0.3.10/V1beta3.WorkerSettings) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class WorkerSettings.\n\nProvides data to pass through to the worker harness.\n\nGenerated from protobuf message `google.dataflow.v1beta3.WorkerSettings`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataflow \\\\ V1beta3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBaseUrl\n\nThe base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\nIf not specified, the default value is \"\u003chttp://www.googleapis.com/\u003e\"\n\n### setBaseUrl\n\nThe base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\nIf not specified, the default value is \"\u003chttp://www.googleapis.com/\u003e\"\n\n### getReportingEnabled\n\nWhether to send work progress updates to the service.\n\n### setReportingEnabled\n\nWhether to send work progress updates to the service.\n\n### getServicePath\n\nThe Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".\n\n### setServicePath\n\nThe Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".\n\n### getShuffleServicePath\n\nThe Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".\n\n### setShuffleServicePath\n\nThe Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".\n\n### getWorkerId\n\nThe ID of the worker running this pipeline.\n\n### setWorkerId\n\nThe ID of the worker running this pipeline.\n\n### getTempStoragePrefix\n\nThe prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\nGoogle Cloud Storage:\nstorage.googleapis.com/{bucket}/{object}\nbucket.storage.googleapis.com/{object}\n\n### setTempStoragePrefix\n\nThe prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\nGoogle Cloud Storage:\nstorage.googleapis.com/{bucket}/{object}\nbucket.storage.googleapis.com/{object}"]]
