Cloud Tasks V2beta3 API - Class Google::Cloud::Tasks::V2beta3::UriOverride (v0.13.0)

Reference documentation and code samples for the Cloud Tasks V2beta3 API class Google::Cloud::Tasks::V2beta3::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

def host() -> ::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=

def host=(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).

#path_override

def path_override() -> ::Google::Cloud::Tasks::V2beta3::PathOverride
Returns

#path_override=

def path_override=(value) -> ::Google::Cloud::Tasks::V2beta3::PathOverride
Parameter
Returns

#port

def port() -> ::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=

def port=(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.

#query_override

def query_override() -> ::Google::Cloud::Tasks::V2beta3::QueryOverride
Returns

#query_override=

def query_override=(value) -> ::Google::Cloud::Tasks::V2beta3::QueryOverride
Parameter
Returns

#scheme

def scheme() -> ::Google::Cloud::Tasks::V2beta3::UriOverride::Scheme
Returns

#scheme=

def scheme=(value) -> ::Google::Cloud::Tasks::V2beta3::UriOverride::Scheme
Parameter
Returns

#uri_override_enforce_mode

def uri_override_enforce_mode() -> ::Google::Cloud::Tasks::V2beta3::UriOverride::UriOverrideEnforceMode
Returns

#uri_override_enforce_mode=

def uri_override_enforce_mode=(value) -> ::Google::Cloud::Tasks::V2beta3::UriOverride::UriOverrideEnforceMode
Parameter
Returns