Class: Google::Apis::PubsubV1::PushConfig
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::PushConfig
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/pubsub_v1/classes.rb,
generated/google/apis/pubsub_v1/representations.rb,
generated/google/apis/pubsub_v1/representations.rb
Overview
Configuration for a push delivery endpoint.
Instance Attribute Summary collapse
-
#attributes ⇒ Hash<String,String>
Endpoint configuration attributes that can be used to control different aspects of the message delivery.
-
#oidc_token ⇒ Google::Apis::PubsubV1::OidcToken
Contains information needed for generating an OpenID Connect token.
-
#push_endpoint ⇒ String
A URL locating the endpoint to which messages should be pushed.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PushConfig
constructor
A new instance of PushConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PushConfig
Returns a new instance of PushConfig.
851 852 853 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 851 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attributes ⇒ Hash<String,String>
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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API. For example:
Corresponds to the JSON propertyattributes <code>"x-goog-version": "v1"</code>
attributes
836 837 838 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 836 def attributes @attributes end |
#oidc_token ⇒ Google::Apis::PubsubV1::OidcToken
Contains information needed for generating an
OpenID Connect
token.
Corresponds to the JSON property oidcToken
843 844 845 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 843 def oidc_token @oidc_token end |
#push_endpoint ⇒ String
A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use "https://example.com/push".
Corresponds to the JSON property pushEndpoint
849 850 851 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 849 def push_endpoint @push_endpoint end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
856 857 858 859 860 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 856 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 |