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

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

Overview

A subscription resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Subscription

Returns a new instance of Subscription.



1249
1250
1251
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1249

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) 


1150
1151
1152
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1150

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:



1158
1159
1160
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1158

def dead_letter_policy
  @dead_letter_policy
end

#detached ⇒ Boolean Also known as: detached?

Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. Corresponds to the JSON property detached

Returns:

  • (Boolean) 


1167
1168
1169
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1167

def detached
  @detached
end

#enable_message_ordering ⇒ Boolean Also known as: enable_message_ordering?

If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. Corresponds to the JSON property enableMessageOrdering

Returns:

  • (Boolean) 


1175
1176
1177
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1175

def enable_message_ordering
  @enable_message_ordering
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:



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

def expiration_policy
  @expiration_policy
end

#filter ⇒ String

An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. Corresponds to the JSON property filter

Returns:

  • (String) 


1190
1191
1192
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1190

def filter
  @filter
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1195
1196
1197
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1195

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) 


1204
1205
1206
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1204

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) 


1214
1215
1216
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1214

def name
  @name
end

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

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

Returns:



1219
1220
1221
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1219

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) 


1228
1229
1230
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1228

def retain_acked_messages
  @retain_acked_messages
end

#retry_policy ⇒ Google::Apis::PubsubV1::RetryPolicy

A policy that specifies how Cloud Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. Corresponds to the JSON property retryPolicy

Returns:



1240
1241
1242
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1240

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


1247
1248
1249
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1247

def topic
  @topic
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1254

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)
  @detached = args[:detached] if args.key?(:detached)
  @enable_message_ordering = args[:enable_message_ordering] if args.key?(:enable_message_ordering)
  @expiration_policy = args[:expiration_policy] if args.key?(:expiration_policy)
  @filter = args[:filter] if args.key?(:filter)
  @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)
  @retry_policy = args[:retry_policy] if args.key?(:retry_policy)
  @topic = args[:topic] if args.key?(:topic)
end