Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::WorkerSettings.
Provides data to pass through to the worker harness.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#base_url
defbase_url()->::String
Returns
(::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/"
#base_url=
defbase_url=(value)->::String
Parameter
value (::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/"
Returns
(::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
defreporting_enabled()->::Boolean
Returns
(::Boolean) — Whether to send work progress updates to the service.
#reporting_enabled=
defreporting_enabled=(value)->::Boolean
Parameter
value (::Boolean) — Whether to send work progress updates to the service.
Returns
(::Boolean) — Whether to send work progress updates to the service.
#service_path
defservice_path()->::String
Returns
(::String) — The Cloud Dataflow service path relative to the root URL, for example,
"dataflow/v1b3/projects".
#service_path=
defservice_path=(value)->::String
Parameter
value (::String) — The Cloud Dataflow service path relative to the root URL, for example,
"dataflow/v1b3/projects".
Returns
(::String) — The Cloud Dataflow service path relative to the root URL, for example,
"dataflow/v1b3/projects".
#shuffle_service_path
defshuffle_service_path()->::String
Returns
(::String) — The Shuffle service path relative to the root URL, for example,
"shuffle/v1beta1".
#shuffle_service_path=
defshuffle_service_path=(value)->::String
Parameter
value (::String) — The Shuffle service path relative to the root URL, for example,
"shuffle/v1beta1".
Returns
(::String) — The Shuffle service path relative to the root URL, for example,
"shuffle/v1beta1".
#temp_storage_prefix
deftemp_storage_prefix()->::String
Returns
(::String) — The prefix of the resources the system should use for temporary
storage.
[[["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-09 UTC."],[],[],null,["# Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::WorkerSettings (v0.13.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.1 (latest)](/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.13.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.12.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.12.1/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.11.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.10.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.9.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.9.1/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.8.2](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.8.2/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.7.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.6.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.6.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.5.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.5.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.4.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.3.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.2.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.2.0/Google-Cloud-Dataflow-V1beta3-WorkerSettings)\n- [0.1.4](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.1.4/Google-Cloud-Dataflow-V1beta3-WorkerSettings) \nReference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::WorkerSettings.\n\nProvides data to pass through to the worker harness. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #base_url\n\n def base_url() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The base URL for accessing Google Cloud APIs.\n\n When workers access Google Cloud APIs, they logically do so via\n relative URLs. If this field is specified, it supplies the base\n URL to use for resolving these relative URLs. The normative\n algorithm used is defined by RFC 1808, \"Relative Uniform Resource\n Locators\".\n\n If not specified, the default value is \"http://www.googleapis.com/\"\n\n### #base_url=\n\n def base_url=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The base URL for accessing Google Cloud APIs.\n\n\n When workers access Google Cloud APIs, they logically do so via\n relative URLs. If this field is specified, it supplies the base\n URL to use for resolving these relative URLs. The normative\n algorithm used is defined by RFC 1808, \"Relative Uniform Resource\n Locators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\" \n**Returns**\n\n- (::String) --- The base URL for accessing Google Cloud APIs.\n\n When workers access Google Cloud APIs, they logically do so via\n relative URLs. If this field is specified, it supplies the base\n URL to use for resolving these relative URLs. The normative\n algorithm used is defined by RFC 1808, \"Relative Uniform Resource\n Locators\".\n\n If not specified, the default value is \"http://www.googleapis.com/\"\n\n### #reporting_enabled\n\n def reporting_enabled() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Whether to send work progress updates to the service.\n\n### #reporting_enabled=\n\n def reporting_enabled=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Whether to send work progress updates to the service. \n**Returns**\n\n- (::Boolean) --- Whether to send work progress updates to the service.\n\n### #service_path\n\n def service_path() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The Cloud Dataflow service path relative to the root URL, for example, \"dataflow/v1b3/projects\".\n\n### #service_path=\n\n def service_path=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The Cloud Dataflow service path relative to the root URL, for example, \"dataflow/v1b3/projects\". \n**Returns**\n\n- (::String) --- The Cloud Dataflow service path relative to the root URL, for example, \"dataflow/v1b3/projects\".\n\n### #shuffle_service_path\n\n def shuffle_service_path() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The Shuffle service path relative to the root URL, for example, \"shuffle/v1beta1\".\n\n### #shuffle_service_path=\n\n def shuffle_service_path=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The Shuffle service path relative to the root URL, for example, \"shuffle/v1beta1\". \n**Returns**\n\n- (::String) --- The Shuffle service path relative to the root URL, for example, \"shuffle/v1beta1\".\n\n### #temp_storage_prefix\n\n def temp_storage_prefix() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The prefix of the resources the system should use for temporary storage.\n\n The supported resource type is:\n\n Google Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}\n\n### #temp_storage_prefix=\n\n def temp_storage_prefix=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The prefix of the resources the system should use for temporary storage.\n\n\n The supported resource type is:\n\n Google Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\nbucket.storage.googleapis.com/{object} \n**Returns**\n\n- (::String) --- The prefix of the resources the system should use for temporary storage.\n\n The supported resource type is:\n\n Google Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}\n\n### #worker_id\n\n def worker_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The ID of the worker running this pipeline.\n\n### #worker_id=\n\n def worker_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The ID of the worker running this pipeline. \n**Returns**\n\n- (::String) --- The ID of the worker running this pipeline."]]