HttpTarget

import type { HttpTarget } from "https://googleapis.deno.dev/v1/cloudtasks:v2.ts";

HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.

interface HttpTarget {

headerOverrides?: HeaderOverride[];

httpMethod?:

| "HTTP_METHOD_UNSPECIFIED"

| "POST"

| "GET"

| "HEAD"

| "PUT"

| "DELETE"

| "PATCH"

| "OPTIONS";

oauthToken?: OAuthToken;

oidcToken?: OidcToken;

uriOverride?: UriOverride;

}

§Properties

headerOverrides?: HeaderOverride[]

[src]

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. 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.

[src]

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.

oauthToken?: OAuthToken

[src]

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.

oidcToken?: OidcToken

[src]

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.

uriOverride?: UriOverride

[src]

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