Class PushConfig (2.13.0)

Version 2.13.0

• 2.27.1 (latest)
• 2.27.0
• 2.26.1
• 2.25.2
• 2.23.1
• 2.22.0
• 2.21.5
• 2.20.3
• 2.19.8
• 2.18.4
• 2.17.1
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.12
• 2.12.1
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.1
• 2.5.0
• 2.4.2
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.2
• 0.45.0
• 0.44.0
• 0.43.0

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

Configuration for a push delivery endpoint.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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	Mapping[str, str] 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" }
oidc_token	google.pubsub_v1.types.PushConfig.OidcToken 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``.

Inheritance

builtins.object > proto.message.Message > PushConfig

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, `.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.

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