HttpTarget
import type { HttpTarget } from "https://googleapis.deno.dev/v1/cloudscheduler:v1.ts";
Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.
§Properties
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 job with an incompatible HttpMethod.
HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below:
- Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB.
Which HTTP method to use for the request.
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.
Required. The full URI path that the request will be sent to. This string
must begin with either "http://" or "https://". Some examples of valid
values for uri are: http://acme.com
and https://acme.com/sales:8080
.
Cloud Scheduler will encode some characters for safety and compatibility.
The maximum allowed URL length is 2083 characters after encoding.