Google.Apis.Pubsub.v1.Data.PushConfig Class Reference

Configuration for a push delivery endpoint. More...

Inheritance diagram for Google.Apis.Pubsub.v1.Data.PushConfig:

Properties
virtual System.Collections.Generic.IDictionary< string, string >	Attributes [get, set]
	Endpoint configuration attributes that can be used to control different aspects of the message delivery. More...
virtual OidcToken	OidcToken [get, set]
	If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. More...
virtual string	PushEndpoint [get, set]
	A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". More...
virtual string	ETag [get, set]
	The ETag of the item. More...
Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string	ETag

Detailed Description

Configuration for a push delivery endpoint.

Property Documentation

Attributes

virtual System.Collections.Generic.IDictionary<string,string> Google.Apis.Pubsub.v1.Data.PushConfig.Attributes

getset

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" }

ETag

virtual string Google.Apis.Pubsub.v1.Data.PushConfig.ETag

getset

The ETag of the item.

OidcToken

virtual OidcToken Google.Apis.Pubsub.v1.Data.PushConfig.OidcToken

getset

If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

PushEndpoint

virtual string Google.Apis.Pubsub.v1.Data.PushConfig.PushEndpoint

getset

A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".

---

The documentation for this class was generated from the following file:

• Google.Apis.Pubsub.v1.cs