Class: Google::Apis::PubsubV1::Subscription
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::Subscription
- 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
A subscription resource.
Instance Attribute Summary collapse
-
#ack_deadline_seconds ⇒ Fixnum
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
-
#name ⇒ String
The name of the subscription.
-
#push_config ⇒ Google::Apis::PubsubV1::PushConfig
Configuration for a push delivery endpoint.
-
#topic ⇒ String
The name of the topic from which this subscription is receiving messages.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Subscription
constructor
A new instance of Subscription.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Subscription
Returns a new instance of Subscription.
396 397 398 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 396 def initialize(**args) update!(**args) end |
Instance Attribute Details
#ack_deadline_seconds ⇒ Fixnum
This value is the maximum time after a subscriber receives a message before
the subscriber should acknowledge the message. After message delivery but
before the ack deadline expires and before the message is acknowledged, it is
an outstanding message and will not be delivered again during that time (on a
best-effort basis). For pull subscriptions, this value is used as the initial
value for the ack deadline. To override this value for a given message, call
ModifyAckDeadline
with the corresponding ack_id
if using pull. The maximum
custom deadline you can specify is 600 seconds (10 minutes). For push delivery,
this value is also used to set the request timeout for the call to the push
endpoint. If the subscriber never acknowledges the message, the Pub/Sub system
will eventually redeliver the message. If this parameter is 0, a default value
of 10 seconds is used.
Corresponds to the JSON property ackDeadlineSeconds
394 395 396 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 394 def ack_deadline_seconds @ack_deadline_seconds end |
#name ⇒ String
The name of the subscription. It must have the format "projects/
project/
subscriptions/
subscription"
. subscription
must start with a letter, and
contain only letters ([A-Za-z]
), numbers ([0-9]
), dashes (-
),
underscores (_
), periods (.
), tildes (~
), plus (+
) or percent signs (%
). It must be between 3 and 255 characters in length, and it must not start
with "goog"
.
Corresponds to the JSON property name
367 368 369 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 367 def name @name end |
#push_config ⇒ Google::Apis::PubsubV1::PushConfig
Configuration for a push delivery endpoint.
Corresponds to the JSON property pushConfig
378 379 380 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 378 def push_config @push_config end |
#topic ⇒ String
The name of the topic from which this subscription is receiving messages. The
value of this field will be _deleted-topic_
if the topic has been deleted.
Corresponds to the JSON property topic
373 374 375 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 373 def topic @topic end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
401 402 403 404 405 406 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 401 def update!(**args) @name = args[:name] if args.key?(:name) @topic = args[:topic] if args.key?(:topic) @push_config = args[:push_config] if args.key?(:push_config) @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds) end |