class Google::Apis::PubsubV1::PushConfig

Configuration for a push delivery endpoint.

Attributes

attributes[RW]

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” ` Corresponds to the JSON property `attributes` @return [Hash<String,String>]

oidc_token[RW]

Contains information needed for generating an [OpenID Connect token](https:// developers.google.com/identity/protocols/OpenIDConnect). Corresponds to the JSON property `oidcToken` @return [Google::Apis::PubsubV1::OidcToken]

push_endpoint[RW]

A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `example.com/push`. Corresponds to the JSON property `pushEndpoint` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/pubsub_v1/classes.rb, line 836
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/pubsub_v1/classes.rb, line 841
def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @oidc_token = args[:oidc_token] if args.key?(:oidc_token)
  @push_endpoint = args[:push_endpoint] if args.key?(:push_endpoint)
end