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.v1.Data

Assembly: Google.Apis.Pubsub.v1.dll

Syntax

public class PushConfig : IDirectResponseSchema

Properties

Attributes

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

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

NoWrapper

Optional. When set, the payload to the push endpoint is not wrapped.

Declaration

[JsonProperty("noWrapper")]
public virtual NoWrapper NoWrapper { get; set; }

Property Value

Type	Description
NoWrapper

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.

Declaration

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

Property Value

Type	Description
OidcToken

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

Declaration

[JsonProperty("pubsubWrapper")]
public virtual PubsubWrapper PubsubWrapper { get; set; }

Property Value

Type	Description
PubsubWrapper

PushEndpoint

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