Class HttpTarget (2.16.2)

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

HTTP target.

When specified as a Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.

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

NameDescription
uri_override google.cloud.tasks_v2beta2.types.UriOverride
Uri override. When specified, overrides the execution Uri for all the tasks in the queue.
http_method google.cloud.tasks_v2beta2.types.HttpMethod
The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod][GET] the HttpRequest][body] of the task will be ignored at execution time.
header_overrides MutableSequence[google.cloud.tasks_v2beta2.types.HttpTarget.HeaderOverride]
HTTP target headers. This map contains the header field names and values. Headers will be set when running the [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/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-CloudTasks". - 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. Queue-level headers to override headers of all the tasks in the queue.
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

Header

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

Defines a header message. A header can have a key and a value.

HeaderOverride

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

Wraps the Header object.