Reference documentation and code samples for the Google Cloud Tasks V2beta2 Client class HttpTarget.
HTTP target.
When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.
Generated from protobuf message google.cloud.tasks.v2beta2.HttpTarget
Namespace
Google \ Cloud \ Tasks \ V2beta2Methods
__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 task is created and/or 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: * * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * * 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 |
↳ oauth_token |
OAuthToken
If specified, an OAuth token will be generated and attached as an |
↳ oidc_token |
OidcToken
If specified, an OIDC token will be 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 |
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
|
Returns | |
---|---|
Type | Description |
$this |
getHeaderOverrides
HTTP target headers.
This map contains the header field names and values. Headers will be set when running the task is created and/or 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:
- Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
- 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-CloudTasks"
. 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. Queue-level headers to override headers of all the tasks in the queue.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setHeaderOverrides
HTTP target headers.
This map contains the header field names and values. Headers will be set when running the task is created and/or 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:
- Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
- 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-CloudTasks"
. 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. Queue-level headers to override headers of all the tasks in the queue.
Parameter | |
---|---|
Name | Description |
var |
array<HttpTarget\HeaderOverride>
|
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 |
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 |
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 |
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 |
OidcToken
|
Returns | |
---|---|
Type | Description |
$this |
getAuthorizationHeader
Returns | |
---|---|
Type | Description |
string |