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

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

#no_wrapper=

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

#oidc_token

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

#oidc_token=

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

#pubsub_wrapper

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

#pubsub_wrapper=

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

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