Class PushConfig

Configuration for a push delivery endpoint.

Inheritance

object

PushConfig

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Pubsub.v1beta2.Data

Assembly: Google.Apis.Pubsub.v1beta2.dll

Syntax

public class PushConfig : IDirectResponseSchema

Properties

Attributes

Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is x-goog-version, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during 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 possible values for this 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.

Declaration

[JsonProperty("attributes")]
public virtual IDictionary<string, string> Attributes { get; set; }

Property Value

Type	Description
IDictionary<string, string>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("oidcToken")]
public virtual OidcToken OidcToken { get; set; }

Property Value

Type	Description
OidcToken

PushEndpoint

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

Declaration

[JsonProperty("pushEndpoint")]
public virtual string PushEndpoint { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema