HttpTargetArgs

data class HttpTargetArgs(val headerOverrides: Output<List<HeaderOverrideArgs>>? = null, val httpMethod: Output<HttpTargetHttpMethod>? = null, val oauthToken: Output<OAuthTokenArgs>? = null, val oidcToken: Output<OidcTokenArgs>? = null, val uriOverride: Output<UriOverrideArgs>? = null) : ConvertibleToJava<HttpTargetArgs>

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

Constructors

Link copied to clipboard
fun HttpTargetArgs(headerOverrides: Output<List<HeaderOverrideArgs>>? = null, httpMethod: Output<HttpTargetHttpMethod>? = null, oauthToken: Output<OAuthTokenArgs>? = null, oidcToken: Output<OidcTokenArgs>? = null, uriOverride: Output<UriOverrideArgs>? = null)

Functions

Link copied to clipboard
open override fun toJava(): HttpTargetArgs

Properties

Link copied to clipboard

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

Link copied to clipboard
val httpMethod: Output<HttpTargetHttpMethod>? = null

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.

Link copied to clipboard
val oauthToken: Output<OAuthTokenArgs>? = null

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.

Link copied to clipboard
val oidcToken: Output<OidcTokenArgs>? = null

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.

Link copied to clipboard
val uriOverride: Output<UriOverrideArgs>? = null

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