Http target. The job will be pushed to the job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1.HttpTarget.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. .. attribute:: uri
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.
The user can specify HTTP request headers to send with the
job's HTTP request. This map contains the header field names
and values. Repeated headers are not supported, but a header
value can contain commas. These headers represent a subset of
the headers that will accompany the job's HTTP request. Some
HTTP request headers will be ignored or replaced. A partial
list of headers that will be 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. The total size
of headers must be less than 80KB.
The mode for generating an Authorization
header for HTTP
requests. If specified, all Authorization
headers in the
[HttpTarget.headers][google.cloud.scheduler.v1.HttpTarget.head
ers] field will be overridden.
If specified, an OIDC <https://developers.google.com/identity
/protocols/OpenIDConnect>
__ 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.
Classes
HeadersEntry
API documentation for scheduler_v1.types.HttpTarget.HeadersEntry
class.