Google Cloud Tasks V2beta3 Client - Class HttpTarget (1.15.0)

Version latest

• 1.15.0 (latest)
• 1.14.6
• 1.13.2
• 1.12.2
• 1.11.11

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Tasks V2beta3 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.v2beta3.HttpTarget

Namespace

Google \ Cloud \ Tasks \ V2beta3

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ uri_override	Google\Cloud\Tasks\V2beta3\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<Google\Cloud\Tasks\V2beta3\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. Content-Type won't be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the task is created. For example,Content-Type can 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.
↳ oauth_token	Google\Cloud\Tasks\V2beta3\OAuthToken If specified, an OAuth token will be generated and attached as the Authorization header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
↳ oidc_token	Google\Cloud\Tasks\V2beta3\OidcToken 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.

getUriOverride

URI override.

When specified, overrides the execution URI for all the tasks in the queue.

Returns
Type	Description
Google\Cloud\Tasks\V2beta3\UriOverride|null

hasUriOverride

clearUriOverride

setUriOverride

URI override.

When specified, overrides the execution URI for all the tasks in the queue.

Parameter
Name	Description
var	Google\Cloud\Tasks\V2beta3\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 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-Type won't be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the task is created. For example,Content-Type can 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.

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 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-Type won't be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the task is created. For example,Content-Type can 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.

Parameter
Name	Description
var	array<Google\Cloud\Tasks\V2beta3\HttpTarget\HeaderOverride>

Returns
Type	Description
$this

getOauthToken

If specified, an OAuth token will be generated and attached as the 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\V2beta3\OAuthToken|null

hasOauthToken

setOauthToken

If specified, an OAuth token will be generated and attached as the 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\V2beta3\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\V2beta3\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\V2beta3\OidcToken

Returns
Type	Description
$this

getAuthorizationHeader

Returns
Type	Description
string