Configuration for a push delivery endpoint.
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
attributes { "x-goog-version": "v1"
}
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
API documentation for pubsub_v1.types.PushConfig.AttributesEntry
class.
OidcToken
Contains information needed for generating an OpenID
Connect
token <https://developers.google.com/identity/protocols/OpenIDConnect>
__.
Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.