Reference documentation and code samples for the Google Cloud Tasks V2 Client class HttpTarget.
HTTP target.
When specified at the Queue level, all tasks with HttpRequest are overridden according to the target.
Generated from protobuf message google.cloud.tasks.v2.HttpTarget
Namespace
Google \ Cloud \ Tasks \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ uri_override |
UriOverride
URI override. When specified, overrides the execution URI for all the tasks in the queue. |
↳ http_method |
int
The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. |
↳ header_overrides |
array<HttpTarget\HeaderOverride>
HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for 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: * * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * * Content-Length: This will be computed by Cloud Tasks. |
↳ oauth_token |
OAuthToken
If specified, an OAuth token is generated and attached as the |
↳ oidc_token |
OidcToken
If specified, an OIDC token is generated and attached as an |
getUriOverride
URI override.
When specified, overrides the execution URI for all the tasks in the queue.
| Returns | |
|---|---|
| Type | Description |
UriOverride|null |
|
hasUriOverride
clearUriOverride
setUriOverride
URI override.
When specified, overrides the execution URI for all the tasks in the queue.
| Parameter | |
|---|---|
| Name | Description |
var |
UriOverride
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHttpMethod
The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type HttpMethod. |
setHttpMethod
The HTTP method to use for the request.
When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type HttpMethod. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHeaderOverrides
HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
Content-Typewon't be set by Cloud Tasks. You can explicitly setContent-Typeto a media type when the task is created. For example,Content-Typecan be set to"application/octet-stream"or"application/json". The default value is set to"application/json". - User-Agent: This will be set to
"Google-Cloud-Tasks". 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. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<HttpTarget\HeaderOverride> |
|
setHeaderOverrides
HTTP target headers.
This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for 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:
- Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task.
- Host: This will be computed by Cloud Tasks and derived from HttpRequest.url.
- Content-Length: This will be computed by Cloud Tasks.
Content-Typewon't be set by Cloud Tasks. You can explicitly setContent-Typeto a media type when the task is created. For example,Content-Typecan be set to"application/octet-stream"or"application/json". The default value is set to"application/json". - User-Agent: This will be set to
"Google-Cloud-Tasks". 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. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.
| Parameter | |
|---|---|
| Name | Description |
var |
array<HttpTarget\HeaderOverride>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOauthToken
If specified, an
OAuth token
is generated and attached as the Authorization header in the HTTP
request.
This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.
| Returns | |
|---|---|
| Type | Description |
OAuthToken|null |
|
hasOauthToken
setOauthToken
If specified, an
OAuth token
is generated and attached as the Authorization header in the HTTP
request.
This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.
| Parameter | |
|---|---|
| Name | Description |
var |
OAuthToken
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOidcToken
If specified, an
OIDC
token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.
| Returns | |
|---|---|
| Type | Description |
OidcToken|null |
|
hasOidcToken
setOidcToken
If specified, an
OIDC
token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.
| Parameter | |
|---|---|
| Name | Description |
var |
OidcToken
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthorizationHeader
| Returns | |
|---|---|
| Type | Description |
string |
|