Class HttpRequest (2.18.0)

Version latest

• 2.18.0 (latest)
• 2.17.1
• 2.16.5
• 2.15.1
• 2.14.2
• 2.13.2
• 2.12.1
• 2.11.0
• 2.10.4
• 2.9.1
• 2.8.1
• 2.7.2
• 2.6.0
• 2.5.3
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.5.2
• 1.4.0
• 1.3.0
• 1.2.1

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

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.

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
url	str Required. 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.
http_method	google.cloud.tasks_v2beta2.types.HttpMethod The HTTP method to use for the request. The default is POST.
headers	MutableMapping[str, str] HTTP request headers. This map contains the header field names and values. Headers can be set when running the [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask]. 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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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.
body	bytes HTTP request body. A request body is allowed only if the [HTTP method][google.cloud.tasks.v2beta2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
oauth_token	google.cloud.tasks_v2beta2.types.OAuthToken If specified, an `OAuth token
oidc_token	google.cloud.tasks_v2beta2.types.OidcToken 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. This field is a member of oneof_ authorization_header.

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.