Class: Google::Cloud::PubSub::V1::Subscription

Inherits:

Object

• Object
• Google::Cloud::PubSub::V1::Subscription

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/pubsub/v1/pubsub.rb

Overview

A subscription resource.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary

• #ack_deadline_seconds ⇒ ::Integer

  The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.

• #dead_letter_policy ⇒ ::Google::Cloud::PubSub::V1::DeadLetterPolicy

  A policy that specifies the conditions for dead lettering messages in this subscription.

• #detached ⇒ ::Boolean

  Indicates whether the subscription is detached from its topic.

• #enable_message_ordering ⇒ ::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.

• #expiration_policy ⇒ ::Google::Cloud::PubSub::V1::ExpirationPolicy

  A policy that specifies the conditions for this subscription's expiration.

• #filter ⇒ ::String

  An expression written in the Pub/Sub filter language.

• #labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  See Creating and managing 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

  Required.

• #push_config ⇒ ::Google::Cloud::PubSub::V1::PushConfig

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

• #retain_acked_messages ⇒ ::Boolean

  Indicates whether to retain acknowledged messages.

• #retry_policy ⇒ ::Google::Cloud::PubSub::V1::RetryPolicy

  A policy that specifies how Pub/Sub retries message delivery for this subscription.

• #topic ⇒ ::String

  Required.

Instance Attribute Details

#ack_deadline_seconds ⇒ ::Integer

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dead_letter_policy ⇒ ::Google::Cloud::PubSub::V1::DeadLetterPolicy

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#detached ⇒ ::Boolean

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enable_message_ordering ⇒ ::Boolean

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#expiration_policy ⇒ ::Google::Cloud::PubSub::V1::ExpirationPolicy

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filter ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#message_retention_duration ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#push_config ⇒ ::Google::Cloud::PubSub::V1::PushConfig

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#retain_acked_messages ⇒ ::Boolean

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#retry_policy ⇒ ::Google::Cloud::PubSub::V1::RetryPolicy

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#topic ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 428

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end