class Google::Apis::PubsubV1::Subscription
A subscription resource.
Attributes
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` @return [Fixnum]
Configuration for a BigQuery subscription. Corresponds to the JSON property `bigqueryConfig` @return [Google::Apis::PubsubV1::BigQueryConfig]
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` @return [Google::Apis::PubsubV1::DeadLetterPolicy]
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` @return [Boolean]
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` @return [Boolean]
If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. Corresponds to the JSON property `enableExactlyOnceDelivery` @return [Boolean]
If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. Corresponds to the JSON property `enableExactlyOnceDelivery` @return [Boolean]
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` @return [Boolean]
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` @return [Boolean]
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion). Corresponds to the JSON property `expirationPolicy` @return [Google::Apis::PubsubV1::ExpirationPolicy]
An expression written in the Pub/Sub [filter language](cloud.google. com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s 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` @return [String]
See Creating and managing labels. Corresponds to the JSON property `labels` @return [Hash<String,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` @return [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` @return [String]
Configuration for a push delivery endpoint. Corresponds to the JSON property `pushConfig` @return [Google::Apis::PubsubV1::PushConfig]
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] (cloud.google.com/ pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously- acknowledged messages. Corresponds to the JSON property `retainAckedMessages` @return [Boolean]
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] (cloud.google.com/ pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously- acknowledged messages. Corresponds to the JSON property `retainAckedMessages` @return [Boolean]
A policy that specifies how Cloud Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. 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` @return [Google::Apis::PubsubV1::RetryPolicy]
Output only. An output-only field indicating whether or not the subscription can receive messages. Corresponds to the JSON property `state` @return [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 be `deleted-topic` if the topic has been deleted. Corresponds to the JSON property `topic` @return [String]
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last ` topic_message_retention_duration
` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. Corresponds to the JSON property `topicMessageRetentionDuration` @return [String]
Public Class Methods
# File lib/google/apis/pubsub_v1/classes.rb, line 1377 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/pubsub_v1/classes.rb, line 1382 def update!(**args) @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds) @bigquery_config = args[:bigquery_config] if args.key?(:bigquery_config) @dead_letter_policy = args[:dead_letter_policy] if args.key?(:dead_letter_policy) @detached = args[:detached] if args.key?(:detached) @enable_exactly_once_delivery = args[:enable_exactly_once_delivery] if args.key?(:enable_exactly_once_delivery) @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) @state = args[:state] if args.key?(:state) @topic = args[:topic] if args.key?(:topic) @topic_message_retention_duration = args[:topic_message_retention_duration] if args.key?(:topic_message_retention_duration) end