Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::PushConfig (v1.3.0)

Version latest

• 1.3.0 (latest)
• 1.2.0
• 1.1.2
• 1.0.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.2
• 0.20.2
• 0.19.0
• 0.18.1
• 0.17.4
• 0.16.0
• 0.15.1
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.2

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::PushConfig.

Configuration for a push delivery endpoint.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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" }

#attributes=

def attributes=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — 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" }

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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" }

#no_wrapper

def no_wrapper() -> ::Google::Cloud::PubSub::V1::PushConfig::NoWrapper

Returns

• (::Google::Cloud::PubSub::V1::PushConfig::NoWrapper) — Optional. When set, the payload to the push endpoint is not wrapped.

#no_wrapper=

def no_wrapper=(value) -> ::Google::Cloud::PubSub::V1::PushConfig::NoWrapper

Parameter

• value (::Google::Cloud::PubSub::V1::PushConfig::NoWrapper) — Optional. When set, the payload to the push endpoint is not wrapped.

Returns

• (::Google::Cloud::PubSub::V1::PushConfig::NoWrapper) — Optional. When set, the payload to the push endpoint is not wrapped.

#oidc_token

def oidc_token() -> ::Google::Cloud::PubSub::V1::PushConfig::OidcToken

Returns

• (::Google::Cloud::PubSub::V1::PushConfig::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.

#oidc_token=

def oidc_token=(value) -> ::Google::Cloud::PubSub::V1::PushConfig::OidcToken

Parameter

• value (::Google::Cloud::PubSub::V1::PushConfig::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.

Returns

• (::Google::Cloud::PubSub::V1::PushConfig::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.

#pubsub_wrapper

def pubsub_wrapper() -> ::Google::Cloud::PubSub::V1::PushConfig::PubsubWrapper

Returns

• (::Google::Cloud::PubSub::V1::PushConfig::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).

#pubsub_wrapper=

def pubsub_wrapper=(value) -> ::Google::Cloud::PubSub::V1::PushConfig::PubsubWrapper

Parameter

• value (::Google::Cloud::PubSub::V1::PushConfig::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).

Returns

• (::Google::Cloud::PubSub::V1::PushConfig::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).

#push_endpoint

def push_endpoint() -> ::String

Returns

• (::String) — Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

#push_endpoint=

def push_endpoint=(value) -> ::String

Parameter

• value (::String) — Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

Returns

• (::String) — Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.