A subscription resource.
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.
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.
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.
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. EXPERIMENTAL:
This feature is part of a closed 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.
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. EXPERIMENTAL: This feature is part of a closed 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.
Classes
LabelsEntry
API documentation for pubsub_v1.types.Subscription.LabelsEntry
class.