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.
-
#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
695 696 697 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 695 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attributes ⇒ 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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API. Corresponds to the JSON propertyattributes
680 681 682 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 680 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
687 688 689 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 687 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
693 694 695 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 693 def push_endpoint @push_endpoint end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
700 701 702 703 704 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 700 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 |