Class: Google::Apis::PubsubV1::Subscription

Inherits:
Object
  • Object
show all
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

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



847
848
849
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 847

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 non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. 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. Corresponds to the JSON property ackDeadlineSeconds

Returns:

  • (Fixnum) 


792
793
794
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 792

def ack_deadline_seconds
  @ack_deadline_seconds
end

#labels ⇒ Hash<String,String>

User labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


797
798
799
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 797

def labels
  @labels
end

#message_retention_duration ⇒ String

How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.

ALPHA: This feature is part of an alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Corresponds to the JSON property messageRetentionDuration

Returns:

  • (String) 


810
811
812
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 810

def message_retention_duration
  @message_retention_duration
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) 


820
821
822
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 820

def name
  @name
end

#push_config ⇒ Google::Apis::PubsubV1::PushConfig

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

Returns:



825
826
827
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 825

def push_config
  @push_config
end

#retain_acked_messages ⇒ Boolean Also known as: retain_acked_messages?

Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the message_retention_duration window.

ALPHA: This feature is part of an alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Corresponds to the JSON property retainAckedMessages

Returns:

  • (Boolean) 


836
837
838
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 836

def retain_acked_messages
  @retain_acked_messages
end

#topic ⇒ String

The name of the topic from which this subscription is receiving messages. Format is projects/project/topics/topic`. The value of this field will bedeleted-topicif the topic has been deleted. Corresponds to the JSON propertytopic`

Returns:

  • (String) 


845
846
847
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 845

def topic
  @topic
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



852
853
854
855
856
857
858
859
860
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 852

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