Cloud Pub/Sub v1 API - Class PushConfig (3.8.0)

public sealed class PushConfig : IMessage<PushConfig>, IEquatable<PushConfig>, IDeepCloneable<PushConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class PushConfig.

Configuration for a push delivery endpoint.

Inheritance

object > PushConfig

Implements

IMessage PushConfig, IEquatable PushConfig, IDeepCloneable PushConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

PushConfig()

public PushConfig()

PushConfig(PushConfig)

public PushConfig(PushConfig other)

Parameter
Name	Description
`other`	`PushConfig`

Properties

Attributes

public MapField<string, string> Attributes { get; }

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

Property Value
Type	Description
`MapFieldstringstring`

AuthenticationMethodCase

public PushConfig.AuthenticationMethodOneofCase AuthenticationMethodCase { get; }

Property Value
Type	Description
`PushConfigAuthenticationMethodOneofCase`

NoWrapper

public PushConfig.Types.NoWrapper NoWrapper { get; set; }

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

Property Value
Type	Description
`PushConfigTypesNoWrapper`

OidcToken

public PushConfig.Types.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.

Property Value
Type	Description
`PushConfigTypesOidcToken`

PubsubWrapper

public PushConfig.Types.PubsubWrapper PubsubWrapper { get; set; }

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

Property Value
Type	Description
`PushConfigTypesPubsubWrapper`

PushEndpoint

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

Property Value
Type	Description
`string`

WrapperCase

public PushConfig.WrapperOneofCase WrapperCase { get; }

Property Value
Type	Description
`PushConfigWrapperOneofCase`