Class PushConfig (2.19.4)

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

Configuration for a push delivery endpoint.

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
push_endpoint :noindex: str
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes :noindex: MutableMapping[str, str]
Optional. 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: attributes { "x-goog-version": "v1" }
oidc_token :noindex: google.pubsub_v1.types.PushConfig.OidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. This field is a member of oneof_ authentication_method.
pubsub_wrapper :noindex: google.pubsub_v1.types.PushConfig.PubsubWrapper
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). This field is a member of oneof_ wrapper.
no_wrapper :noindex: google.pubsub_v1.types.PushConfig.NoWrapper
Optional. When set, the payload to the push endpoint is not wrapped. This field is a member of oneof_ wrapper.

Classes

AttributesEntry

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

The abstract base class for a message.

Parameters
NameDescription
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.

NoWrapper

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

Sets the data field as the HTTP body for delivery.

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>__.

PubsubWrapper

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

The payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).