View Source GoogleApi.PubSub.V1.Model.PushConfig (google_api_pub_sub v0.38.0)
Configuration for a push delivery endpoint.
Attributes
-
attributes
(type:map()
, default:nil
) - Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute isx-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 theCreateSubscription
call, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfig
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 thex-goog-version
attribute are:v1beta1
: uses the push format defined in the v1beta1 Pub/Sub API.v1
orv1beta2
: uses the push format defined in the v1 Pub/Sub API. For example:attributes { "x-goog-version": "v1" }
-
noWrapper
(type:GoogleApi.PubSub.V1.Model.NoWrapper.t
, default:nil
) - Optional. When set, the payload to the push endpoint is not wrapped. -
oidcToken
(type:GoogleApi.PubSub.V1.Model.OidcToken.t
, default:nil
) - Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as anAuthorization
header in the HTTP request for every pushed message. -
pubsubWrapper
(type:GoogleApi.PubSub.V1.Model.PubsubWrapper.t
, default:nil
) - 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). -
pushEndpoint
(type:String.t
, default:nil
) - Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might usehttps://example.com/push
.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.PubSub.V1.Model.PushConfig{ attributes: map() | nil, noWrapper: GoogleApi.PubSub.V1.Model.NoWrapper.t() | nil, oidcToken: GoogleApi.PubSub.V1.Model.OidcToken.t() | nil, pubsubWrapper: GoogleApi.PubSub.V1.Model.PubsubWrapper.t() | nil, pushEndpoint: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.