Class: Google::Apis::PubsubV1beta2::Subscription

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/pubsub_v1beta2/classes.rb,
generated/google/apis/pubsub_v1beta2/representations.rb,
generated/google/apis/pubsub_v1beta2/representations.rb

Overview

A subscription resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Subscription

Returns a new instance of Subscription



621
622
623
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 621

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

Returns:

  • (Fixnum) 


597
598
599
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 597

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

Returns:

  • (String) 


607
608
609
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 607

def name
  @name
end

#push_config ⇒ Google::Apis::PubsubV1beta2::PushConfig

Configuration for a push delivery endpoint. Corresponds to the JSON property pushConfig

Returns:



612
613
614
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 612

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

Returns:

  • (String) 


619
620
621
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 619

def topic
  @topic
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



626
627
628
629
630
631
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 626

def update!(**args)
  @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
  @name = args[:name] if args.key?(:name)
  @push_config = args[:push_config] if args.key?(:push_config)
  @topic = args[:topic] if args.key?(:topic)
end