UriOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)URI Override.
When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
|---|---|
| Name | Description |
scheme |
google.cloud.tasks_v2beta3.types.UriOverride.Scheme
Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). This field is a member of oneof_ _scheme.
|
host |
str
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). This field is a member of oneof_ _host.
|
port |
int
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. This field is a member of oneof_ _port.
|
path_override |
google.cloud.tasks_v2beta3.types.PathOverride
URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. |
query_override |
google.cloud.tasks_v2beta3.types.QueryOverride
URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. |
uri_override_enforce_mode |
google.cloud.tasks_v2beta3.types.UriOverride.UriOverrideEnforceMode
URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. |
Classes
Scheme
Scheme(value)The Scheme for an HTTP request. By default, it is HTTPS.
Values: SCHEME_UNSPECIFIED (0): Scheme unspecified. Defaults to HTTPS. HTTP (1): Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca. HTTPS (2): Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca.
UriOverrideEnforceMode
UriOverrideEnforceMode(value)UriOverrideEnforceMode mode is to define enforcing mode for the override modes.
Values: URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED (0): OverrideMode Unspecified. Defaults to ALWAYS. IF_NOT_EXISTS (1): In the IF_NOT_EXISTS mode, queue-level configuration is only applied where task-level configuration does not exist. ALWAYS (2): In the ALWAYS mode, queue-level configuration overrides all task-level configuration