Reference documentation and code samples for the Google Cloud Tasks V2 Client class HttpRequest.
HTTP request.
The task will be pushed to the worker as an HTTP request. If the worker
or the redirected worker acknowledges the task by returning a successful HTTP
response code ([200
- 299
]), the task will be removed from the queue. If
any other HTTP response code is returned or no response is received, the
task will be retried according to the following:
- User-specified throttling: retry configuration, rate limits, and the queue's state.
- System throttling: To prevent the worker from overloading, Cloud Tasks may
temporarily reduce the queue's effective rate. User-specified settings
will not be changed.
System throttling happens because:
- Cloud Tasks backs off on all errors. Normally the backoff specified in
rate limits will be used. But
if the worker returns
429
(Too Many Requests),503
(Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in theRetry-After
HTTP response header is considered. - To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).
- Cloud Tasks backs off on all errors. Normally the backoff specified in
rate limits will be used. But
if the worker returns
Generated from protobuf message google.cloud.tasks.v2.HttpRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ url |
string
Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: |
↳ http_method |
int
The HTTP method to use for the request. The default is POST. |
↳ headers |
array|Google\Protobuf\Internal\MapField
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to |
↳ body |
string
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. |
↳ oauth_token |
Google\Cloud\Tasks\V2\OAuthToken
If specified, an OAuth token will be generated and attached as an |
↳ oidc_token |
Google\Cloud\Tasks\V2\OidcToken
If specified, an OIDC token will be generated and attached as an |
getUrl
Required. The full url path that the request will be sent to.
This string must begin with either "http://" or "https://". Some examples
are: http://acme.com
and https://acme.com/sales:8080
. Cloud Tasks will
encode some characters for safety and compatibility. The maximum allowed
URL length is 2083 characters after encoding.
The Location
header response from a redirect response [300
- 399
]
may be followed. The redirect is not counted as a separate attempt.
Returns | |
---|---|
Type | Description |
string |
setUrl
Required. The full url path that the request will be sent to.
This string must begin with either "http://" or "https://". Some examples
are: http://acme.com
and https://acme.com/sales:8080
. Cloud Tasks will
encode some characters for safety and compatibility. The maximum allowed
URL length is 2083 characters after encoding.
The Location
header response from a redirect response [300
- 399
]
may be followed. The redirect is not counted as a separate attempt.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getHttpMethod
The HTTP method to use for the request. The default is POST.
Returns | |
---|---|
Type | Description |
int |
setHttpMethod
The HTTP method to use for the request. The default is POST.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getHeaders
HTTP request headers.
This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is:
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-Cloud-Tasks"
. X-Google-*
: Google use only.X-AppEngine-*
: Google use only.Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setHeaders
HTTP request headers.
This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is:
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-Cloud-Tasks"
. X-Google-*
: Google use only.X-AppEngine-*
: Google use only.Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getBody
HTTP request body.
A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
Returns | |
---|---|
Type | Description |
string |
setBody
HTTP request body.
A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOauthToken
If specified, an
OAuth token
will be generated and attached as an Authorization
header in the HTTP
request.
This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
Returns | |
---|---|
Type | Description |
Google\Cloud\Tasks\V2\OAuthToken|null |
hasOauthToken
setOauthToken
If specified, an
OAuth token
will be generated and attached as an Authorization
header in the HTTP
request.
This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Tasks\V2\OAuthToken
|
Returns | |
---|---|
Type | Description |
$this |
getOidcToken
If specified, an
OIDC
token will be generated and attached as an Authorization
header in the
HTTP request.
This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
Returns | |
---|---|
Type | Description |
Google\Cloud\Tasks\V2\OidcToken|null |
hasOidcToken
setOidcToken
If specified, an
OIDC
token will be generated and attached as an Authorization
header in the
HTTP request.
This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Tasks\V2\OidcToken
|
Returns | |
---|---|
Type | Description |
$this |
getAuthorizationHeader
Returns | |
---|---|
Type | Description |
string |