Reference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::UriOverride.
Uri Override.
When specified, all the HTTP tasks inside the queue will be partially or
fully overridden depending on the configured values.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#host
defhost()->::String
Returns
(::String) — Host override.
When specified, replaces the host part of the task URL. For example,
if the task URL is "https://www.google.com," and host value is set to
"example.net", the overridden URI will be changed to "https://example.net."
Host value cannot be an empty string (INVALID_ARGUMENT).
#host=
defhost=(value)->::String
Parameter
value (::String) — Host override.
When specified, replaces the host part of the task URL. For example,
if the task URL is "https://www.google.com," and host value is set to
"example.net", the overridden URI will be changed to "https://example.net."
Host value cannot be an empty string (INVALID_ARGUMENT).
Returns
(::String) — Host override.
When specified, replaces the host part of the task URL. For example,
if the task URL is "https://www.google.com," and host value is set to
"example.net", the overridden URI will be changed to "https://example.net."
Host value cannot be an empty string (INVALID_ARGUMENT).
When specified, replaces the existing path of the task URL. Setting the
path value to an empty string clears the URI path segment.
#port
defport()->::Integer
Returns
(::Integer) — Port override.
When specified, replaces the port part of the task URI. For instance,
for a URI http://www.google.com/foo and port=123, the overridden URI
becomes http://www.google.com:123/foo. Note that the port value must be a
positive integer. Setting the port to 0 (Zero) clears the URI port.
#port=
defport=(value)->::Integer
Parameter
value (::Integer) — Port override.
When specified, replaces the port part of the task URI. For instance,
for a URI http://www.google.com/foo and port=123, the overridden URI
becomes http://www.google.com:123/foo. Note that the port value must be a
positive integer. Setting the port to 0 (Zero) clears the URI port.
Returns
(::Integer) — Port override.
When specified, replaces the port part of the task URI. For instance,
for a URI http://www.google.com/foo and port=123, the overridden URI
becomes http://www.google.com:123/foo. Note that the port value must be a
positive integer. Setting the port to 0 (Zero) clears the URI port.
[[["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-08-28 UTC."],[],[],null,["# Cloud Tasks V2beta2 API - Class Google::Cloud::Tasks::V2beta2::UriOverride (v0.15.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.15.0 (latest)](/ruby/docs/reference/google-cloud-tasks-v2beta2/latest/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.14.1](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.14.1/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.13.0](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.13.0/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.12.1](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.12.1/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.11.3](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.11.3/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.10.0](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.10.0/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.9.2](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.9.2/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.8.0](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.8.0/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.7.0](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.7.0/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.6.0](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.6.0/Google-Cloud-Tasks-V2beta2-UriOverride)\n- [0.5.5](/ruby/docs/reference/google-cloud-tasks-v2beta2/0.5.5/Google-Cloud-Tasks-V2beta2-UriOverride) \nReference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::UriOverride.\n\nUri Override.\n\n\n\u003cbr /\u003e\n\nWhen specified, all the HTTP tasks inside the queue will be partially or\nfully overridden depending on the configured values. \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### #host\n\n def host() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Host override.\n\n When specified, replaces the host part of the task URL. For example,\n if the task URL is \"https://www.google.com,\" and host value is set to\n \"example.net\", the overridden URI will be changed to \"https://example.net.\"\n Host value cannot be an empty string (INVALID_ARGUMENT).\n\n### #host=\n\n def host=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Host override.\n\n\n When specified, replaces the host part of the task URL. For example,\n if the task URL is \"https://www.google.com,\" and host value is set to\n \"example.net\", the overridden URI will be changed to \"https://example.net.\"\nHost value cannot be an empty string (INVALID_ARGUMENT). \n**Returns**\n\n- (::String) --- Host override.\n\n When specified, replaces the host part of the task URL. For example,\n if the task URL is \"https://www.google.com,\" and host value is set to\n \"example.net\", the overridden URI will be changed to \"https://example.net.\"\n Host value cannot be an empty string (INVALID_ARGUMENT).\n\n### #path_override\n\n def path_override() -\u003e ::Google::Cloud::Tasks::V2beta2::PathOverride\n\n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::PathOverride](./Google-Cloud-Tasks-V2beta2-PathOverride)) --- URI path.\n\n\n When specified, replaces the existing path of the task URL. Setting the\n path value to an empty string clears the URI path segment.\n\n### #path_override=\n\n def path_override=(value) -\u003e ::Google::Cloud::Tasks::V2beta2::PathOverride\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Tasks::V2beta2::PathOverride](./Google-Cloud-Tasks-V2beta2-PathOverride)) --- URI path.\n\n\n When specified, replaces the existing path of the task URL. Setting the\npath value to an empty string clears the URI path segment. \n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::PathOverride](./Google-Cloud-Tasks-V2beta2-PathOverride)) --- URI path.\n\n\n When specified, replaces the existing path of the task URL. Setting the\n path value to an empty string clears the URI path segment.\n\n### #port\n\n def port() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Port override.\n\n When specified, replaces the port part of the task URI. For instance,\n for a URI http://www.google.com/foo and port=123, the overridden URI\n becomes http://www.google.com:123/foo. Note that the port value must be a\n positive integer. Setting the port to 0 (Zero) clears the URI port.\n\n### #port=\n\n def port=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Port override.\n\n\n When specified, replaces the port part of the task URI. For instance,\n for a URI http://www.google.com/foo and port=123, the overridden URI\n becomes http://www.google.com:123/foo. Note that the port value must be a\npositive integer. Setting the port to 0 (Zero) clears the URI port. \n**Returns**\n\n- (::Integer) --- Port override.\n\n When specified, replaces the port part of the task URI. For instance,\n for a URI http://www.google.com/foo and port=123, the overridden URI\n becomes http://www.google.com:123/foo. Note that the port value must be a\n positive integer. Setting the port to 0 (Zero) clears the URI port.\n\n### #query_override\n\n def query_override() -\u003e ::Google::Cloud::Tasks::V2beta2::QueryOverride\n\n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::QueryOverride](./Google-Cloud-Tasks-V2beta2-QueryOverride)) --- URI Query.\n\n\n When specified, replaces the query part of the task URI. Setting the\n query value to an empty string clears the URI query segment.\n\n### #query_override=\n\n def query_override=(value) -\u003e ::Google::Cloud::Tasks::V2beta2::QueryOverride\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Tasks::V2beta2::QueryOverride](./Google-Cloud-Tasks-V2beta2-QueryOverride)) --- URI Query.\n\n\n When specified, replaces the query part of the task URI. Setting the\nquery value to an empty string clears the URI query segment. \n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::QueryOverride](./Google-Cloud-Tasks-V2beta2-QueryOverride)) --- URI Query.\n\n\n When specified, replaces the query part of the task URI. Setting the\n query value to an empty string clears the URI query segment.\n\n### #scheme\n\n def scheme() -\u003e ::Google::Cloud::Tasks::V2beta2::UriOverride::Scheme\n\n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::UriOverride::Scheme](./Google-Cloud-Tasks-V2beta2-UriOverride-Scheme)) --- Scheme override.\n\n\n When specified, the task URI scheme is replaced by the provided value (HTTP\n or HTTPS).\n\n### #scheme=\n\n def scheme=(value) -\u003e ::Google::Cloud::Tasks::V2beta2::UriOverride::Scheme\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Tasks::V2beta2::UriOverride::Scheme](./Google-Cloud-Tasks-V2beta2-UriOverride-Scheme)) --- Scheme override.\n\n\n When specified, the task URI scheme is replaced by the provided value (HTTP\nor HTTPS). \n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::UriOverride::Scheme](./Google-Cloud-Tasks-V2beta2-UriOverride-Scheme)) --- Scheme override.\n\n\n When specified, the task URI scheme is replaced by the provided value (HTTP\n or HTTPS).\n\n### #uri_override_enforce_mode\n\n def uri_override_enforce_mode() -\u003e ::Google::Cloud::Tasks::V2beta2::UriOverride::UriOverrideEnforceMode\n\n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::UriOverride::UriOverrideEnforceMode](./Google-Cloud-Tasks-V2beta2-UriOverride-UriOverrideEnforceMode)) --- URI Override Enforce Mode\n\n\n When specified, determines the Target UriOverride mode. If not specified,\n it defaults to ALWAYS.\n\n### #uri_override_enforce_mode=\n\n def uri_override_enforce_mode=(value) -\u003e ::Google::Cloud::Tasks::V2beta2::UriOverride::UriOverrideEnforceMode\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Tasks::V2beta2::UriOverride::UriOverrideEnforceMode](./Google-Cloud-Tasks-V2beta2-UriOverride-UriOverrideEnforceMode)) --- URI Override Enforce Mode\n\n\n When specified, determines the Target UriOverride mode. If not specified,\nit defaults to ALWAYS. \n**Returns**\n\n- ([::Google::Cloud::Tasks::V2beta2::UriOverride::UriOverrideEnforceMode](./Google-Cloud-Tasks-V2beta2-UriOverride-UriOverrideEnforceMode)) --- URI Override Enforce Mode\n\n\n When specified, determines the Target UriOverride mode. If not specified,\n it defaults to ALWAYS."]]
