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.



1182
1183
1184
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1182

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ack_deadline_seconds ⇒ Fixnum

The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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) 


1114
1115
1116
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1114

def ack_deadline_seconds
  @ack_deadline_seconds
end

#dead_letter_policy ⇒ Google::Apis::PubsubV1::DeadLetterPolicy

Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail. Corresponds to the JSON property deadLetterPolicy

Returns:



1122
1123
1124
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1122

def dead_letter_policy
  @dead_letter_policy
end

#expiration_policy ⇒ Google::Apis::PubsubV1::ExpirationPolicy

A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion). Corresponds to the JSON property expirationPolicy

Returns:



1128
1129
1130
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1128

def expiration_policy
  @expiration_policy
end

#labels ⇒ Hash<String,String>

See Creating and managing labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1134
1135
1136
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1134

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. Corresponds to the JSON property messageRetentionDuration

Returns:

  • (String) 


1144
1145
1146
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1144

def message_retention_duration
  @message_retention_duration
end

#name ⇒ String

Required. 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) 


1154
1155
1156
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1154

def name
  @name
end

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

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

Returns:



1159
1160
1161
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1159

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. This must be true if you would like to Seek to a timestamp. Corresponds to the JSON property retainAckedMessages

Returns:

  • (Boolean) 


1170
1171
1172
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1170

def retain_acked_messages
  @retain_acked_messages
end

#topic ⇒ String

Required. 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) 


1180
1181
1182
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1180

def topic
  @topic
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1187

def update!(**args)
  @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
  @dead_letter_policy = args[:dead_letter_policy] if args.key?(:dead_letter_policy)
  @expiration_policy = args[:expiration_policy] if args.key?(:expiration_policy)
  @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