pulumi-google-native-kotlin/com.pulumi.googlenative.cloudtasks.v2beta2.kotlin.inputs/HttpRequestArgs

HttpRequestArgs

data class HttpRequestArgs(val body: Output<String>? = null, val headers: Output<Map<String, String>>? = null, val httpMethod: Output<HttpRequestHttpMethod>? = null, val oauthToken: Output<OAuthTokenArgs>? = null, val oidcToken: Output<OidcTokenArgs>? = null, val url: Output<String>) : ConvertibleToJava<HttpRequestArgs>

HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.

Constructors

HttpRequestArgs

fun HttpRequestArgs(body: Output<String>? = null, headers: Output<Map<String, String>>? = null, httpMethod: Output<HttpRequestHttpMethod>? = null, oauthToken: Output<OAuthTokenArgs>? = null, oidcToken: Output<OidcTokenArgs>? = null, url: Output<String>)

Functions

toJava

open override fun toJava(): HttpRequestArgs

Properties

body

val body: Output<String>? = null

HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.

headers

val headers: Output<Map<String, String>>? = null

HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created 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-Cloud-Tasks". * 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.

httpMethod

val httpMethod: Output<HttpRequestHttpMethod>? = null

The HTTP method to use for the request. The default is POST.

oauthToken

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.

oidcToken

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.

url

val url: Output<String>

The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location header response from a redirect response `300` - `399` may be followed. The redirect is not counted as a separate attempt.