Class: Google::Pubsub::V1::Subscription

Inherits:

Object

• Object
• Google::Pubsub::V1::Subscription

Defined in:

lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

A subscription resource.

Instance Attribute Summary

• #ack_deadline_seconds ⇒ Integer

  This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.

• #labels ⇒ Hash{String => String}

  User labels.

• #message_retention_duration ⇒ Google::Protobuf::Duration

  How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.

• #name ⇒ String

  The name of the subscription.

• #push_config ⇒ Google::Pubsub::V1::PushConfig

  If push delivery is used with this subscription, this field is used to configure it.

• #retain_acked_messages ⇒ true, false

  Indicates whether to retain acknowledged messages.

• #topic ⇒ String

  The name of the topic from which this subscription is receiving messages.

Instance Attribute Details

#ack_deadline_seconds ⇒ Integer

Returns 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.

Returns:

• (Integer) —

  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.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 264

class Subscription; end

#labels ⇒ Hash{String => String}

Returns User labels.

Returns:

• (Hash{String => String}) —

  User labels.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 264

class Subscription; end

#message_retention_duration ⇒ Google::Protobuf::Duration

Returns 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.

Returns:

• (Google::Protobuf::Duration) —

  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.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 264

class Subscription; end

#name ⇒ String

Returns 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"+

Returns:

• (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"+

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 264

class Subscription; end

#push_config ⇒ Google::Pubsub::V1::PushConfig

Returns If push delivery is used with this subscription, this field is used to configure it. An empty +pushConfig+ signifies that the subscriber will pull and ack messages using API methods.

Returns:

• (Google::Pubsub::V1::PushConfig) —

  If push delivery is used with this subscription, this field is used to configure it. An empty +pushConfig+ signifies that the subscriber will pull and ack messages using API methods.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 264

class Subscription; end

#retain_acked_messages ⇒ true, false

Returns 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.

Returns:

• (true, false) —

  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.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 264

class Subscription; end

#topic ⇒ String

Returns 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.

Returns:

• (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 be +deleted-topic+ if the topic has been deleted.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 264

class Subscription; end