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 collapse
-
#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
inPubsubMessage
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}
-
#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.
-
#topic_message_retention_duration ⇒ ::Google::Protobuf::Duration
readonly
Output only.
Instance Attribute Details
#ack_deadline_seconds ⇒ ::Integer
Returns 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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled.
The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns 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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns 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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns A policy that specifies the conditions for this subscription's expiration.
A subscription is considered active as long as any connected subscriber is
successfully consuming messages from the subscription or is issuing
operations on the subscription. If expiration_policy
is not set, a
default policy with ttl
of 31 days will be used. The minimum allowed
value for expiration_policy.ttl
is 1 day.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns An expression written in the Pub/Sub filter
language. 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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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}
Returns See Creating and managing labels.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns 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"
.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
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. This must be true if you would like to Seek
to a timestamp in
the past to replay previously-acknowledged messages.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns A policy that specifies how Pub/Sub retries message delivery for this subscription.
If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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
Returns 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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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_message_retention_duration ⇒ ::Google::Protobuf::Duration (readonly)
Returns 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.
445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 445 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 |