Class HttpTarget (2.7.0)

HttpTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
uri	`str` 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.
http_method	`google.cloud.scheduler_v1beta1.types.HttpMethod` Which HTTP method to use for the request.
headers	`Mapping[str, str]` 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.
body	`bytes` 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.
oauth_token	`google.cloud.scheduler_v1beta1.types.OAuthToken` If specified, an `OAuth token
oidc_token	`google.cloud.scheduler_v1beta1.types.OidcToken` If specified, an `OIDC

Inheritance

builtins.object > proto.message.Message > HttpTarget

Classes

HeadersEntry

HeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
kwargs	`dict` Keys and values corresponding to the fields of the message.
mapping	Union[dict, `.Message`] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.