Reference documentation and code samples for the Google Cloud Tasks V2beta3 Client class UriOverride.
URI Override.
When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.
Generated from protobuf message google.cloud.tasks.v2beta3.UriOverride
Namespace
Google \ Cloud \ Tasks \ V2beta3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ scheme |
int
Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). |
↳ host |
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). |
↳ port |
int|string
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. |
↳ path_override |
Google\Cloud\Tasks\V2beta3\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\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 |
int
URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. |
getScheme
Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
| Returns | |
|---|---|
| Type | Description |
int | |
hasScheme
clearScheme
setScheme
Scheme override.
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHost
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 | |
|---|---|
| Type | Description |
string | |
hasHost
clearHost
setHost
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).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPort
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 | |
|---|---|
| Type | Description |
int|string | |
hasPort
clearPort
setPort
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPathOverride
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Tasks\V2beta3\PathOverride|null | |
hasPathOverride
clearPathOverride
setPathOverride
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Tasks\V2beta3\PathOverride
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryOverride
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Tasks\V2beta3\QueryOverride|null | |
hasQueryOverride
clearQueryOverride
setQueryOverride
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Tasks\V2beta3\QueryOverride
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUriOverrideEnforceMode
URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
| Returns | |
|---|---|
| Type | Description |
int | |
setUriOverrideEnforceMode
URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |