PushConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for a push delivery endpoint.
Attributes | |
---|---|
Name | Description |
push_endpoint |
str
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push .
|
attributes |
Sequence[
Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version , which you can use to change the format
of the pushed message. This attribute indicates the version
of the data expected by the endpoint. This controls the
shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it
will default to the version of the Pub/Sub API used to make
such call. If not present in a ModifyPushConfig call,
its value will not be changed. GetSubscription calls
will always return a valid version, even if the subscription
was created without this attribute.
The only supported values for the x-goog-version
attribute are:
- v1beta1 : uses the push format defined in the v1beta1
Pub/Sub API.
- v1 or v1beta2 : uses the push format defined in
the v1 Pub/Sub API.
For example:
.. raw:: html
|
oidc_token |
If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for
every pushed message.
|
Classes
AttributesEntry
AttributesEntry(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,
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 |
OidcToken
OidcToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Contains information needed for generating an OpenID Connect
token <https://developers.google.com/identity/protocols/OpenIDConnect>
__.