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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class PushConfig (2.31.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.31.0 (latest)](/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.PushConfig)\n- [2.30.0](/python/docs/reference/pubsub/2.30.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.29.1](/python/docs/reference/pubsub/2.29.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.28.0](/python/docs/reference/pubsub/2.28.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.27.3](/python/docs/reference/pubsub/2.27.3/google.cloud.pubsub_v1.types.PushConfig)\n- [2.26.1](/python/docs/reference/pubsub/2.26.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.25.2](/python/docs/reference/pubsub/2.25.2/google.cloud.pubsub_v1.types.PushConfig)\n- [2.23.1](/python/docs/reference/pubsub/2.23.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.22.0](/python/docs/reference/pubsub/2.22.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.21.5](/python/docs/reference/pubsub/2.21.5/google.cloud.pubsub_v1.types.PushConfig)\n- [2.20.3](/python/docs/reference/pubsub/2.20.3/google.cloud.pubsub_v1.types.PushConfig)\n- [2.19.8](/python/docs/reference/pubsub/2.19.8/google.cloud.pubsub_v1.types.PushConfig)\n- [2.18.4](/python/docs/reference/pubsub/2.18.4/google.cloud.pubsub_v1.types.PushConfig)\n- [2.17.1](/python/docs/reference/pubsub/2.17.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.16.1](/python/docs/reference/pubsub/2.16.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.15.2](/python/docs/reference/pubsub/2.15.2/google.cloud.pubsub_v1.types.PushConfig)\n- [2.14.1](/python/docs/reference/pubsub/2.14.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.13.12](/python/docs/reference/pubsub/2.13.12/google.cloud.pubsub_v1.types.PushConfig)\n- [2.12.1](/python/docs/reference/pubsub/2.12.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.11.1](/python/docs/reference/pubsub/2.11.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.10.0](/python/docs/reference/pubsub/2.10.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.9.0](/python/docs/reference/pubsub/2.9.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.8.0](/python/docs/reference/pubsub/2.8.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.7.1](/python/docs/reference/pubsub/2.7.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.6.1](/python/docs/reference/pubsub/2.6.1/google.cloud.pubsub_v1.types.PushConfig)\n- [2.5.0](/python/docs/reference/pubsub/2.5.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.4.2](/python/docs/reference/pubsub/2.4.2/google.cloud.pubsub_v1.types.PushConfig)\n- [2.3.0](/python/docs/reference/pubsub/2.3.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.2.0](/python/docs/reference/pubsub/2.2.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.1.0](/python/docs/reference/pubsub/2.1.0/google.cloud.pubsub_v1.types.PushConfig)\n- [2.0.0](/python/docs/reference/pubsub/2.0.0/google.cloud.pubsub_v1.types.PushConfig)\n- [1.7.2](/python/docs/reference/pubsub/1.7.2/google.cloud.pubsub_v1.types.PushConfig)\n- [1.6.1](/python/docs/reference/pubsub/1.6.1/google.cloud.pubsub_v1.types.PushConfig)\n- [1.5.0](/python/docs/reference/pubsub/1.5.0/google.cloud.pubsub_v1.types.PushConfig)\n- [1.4.3](/python/docs/reference/pubsub/1.4.3/google.cloud.pubsub_v1.types.PushConfig)\n- [1.3.1](/python/docs/reference/pubsub/1.3.1/google.cloud.pubsub_v1.types.PushConfig)\n- [1.2.0](/python/docs/reference/pubsub/1.2.0/google.cloud.pubsub_v1.types.PushConfig)\n- [1.1.0](/python/docs/reference/pubsub/1.1.0/google.cloud.pubsub_v1.types.PushConfig)\n- [1.0.2](/python/docs/reference/pubsub/1.0.2/google.cloud.pubsub_v1.types.PushConfig)\n- [0.45.0](/python/docs/reference/pubsub/0.45.0/google.cloud.pubsub_v1.types.PushConfig)\n- [0.44.0](/python/docs/reference/pubsub/0.44.0/google.cloud.pubsub_v1.types.PushConfig)\n- [0.43.0](/python/docs/reference/pubsub/0.43.0/google.cloud.pubsub_v1.types.PushConfig) \n\n PushConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nConfiguration for a push delivery endpoint.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### AttributesEntry\n\n AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message.\n\n### NoWrapper\n\n NoWrapper(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSets the `data` field as the HTTP body for delivery.\n\n### OidcToken\n\n OidcToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nContains information needed for generating an `OpenID Connect\ntoken \u003chttps://developers.google.com/identity/protocols/OpenIDConnect\u003e`__.\n\n### PubsubWrapper\n\n PubsubWrapper(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe payload to the push endpoint is in the form of the JSON\nrepresentation of a PubsubMessage\n(\u003chttps://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage\u003e)."]]