Class: Google::Pubsub::V1::PushConfig

Inherits:

Object

• Object
• Google::Pubsub::V1::PushConfig

Defined in:

lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

Configuration for a push delivery endpoint.

Instance Attribute Summary

• #attributes ⇒ Hash{String => String}

  Endpoint configuration attributes.

• #push_endpoint ⇒ String

  A URL locating the endpoint to which messages should be pushed.

Instance Attribute Details

#attributes ⇒ Hash{String => String}

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

Returns:

• (Hash{String => String}) —

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

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 218

class PushConfig; end

#push_endpoint ⇒ String

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

Returns:

• (String) —

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

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 218

class PushConfig; end