Class Subscription (2.13.5)

Version 2.13.5

• 2.27.1 (latest)
• 2.27.0
• 2.26.1
• 2.25.2
• 2.23.1
• 2.22.0
• 2.21.5
• 2.20.3
• 2.19.8
• 2.18.4
• 2.17.1
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.12
• 2.12.1
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.1
• 2.5.0
• 2.4.2
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.2
• 0.45.0
• 0.44.0
• 0.43.0

Subscription(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A subscription resource.

Attributes

Name	Description
name	str 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"``.
topic	str 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.
push_config	google.pubsub_v1.types.PushConfig If push delivery is used with this subscription, this field is used to configure it. Either ``pushConfig`` or ``bigQueryConfig`` can be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
bigquery_config	google.pubsub_v1.types.BigQueryConfig If delivery to BigQuery is used with this subscription, this field is used to configure it. Either ``pushConfig`` or ``bigQueryConfig`` can be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
ack_deadline_seconds	int 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.
retain_acked_messages	bool 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] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
message_retention_duration	google.protobuf.duration_pb2.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.
labels	Mapping[str, str] See Creating and managing labels.
enable_message_ordering	bool 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.
expiration_policy	google.pubsub_v1.types.ExpirationPolicy 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.
filter	str An expression written in the Pub/Sub `filter language
dead_letter_policy	google.pubsub_v1.types.DeadLetterPolicy 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.
retry_policy	google.pubsub_v1.types.RetryPolicy 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.
detached	bool 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.
enable_exactly_once_delivery	bool 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.
topic_message_retention_duration	google.protobuf.duration_pb2.Duration 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.
state	google.pubsub_v1.types.Subscription.State Output only. An output-only field indicating whether or not the subscription can receive messages.

Inheritance

builtins.object > proto.message.Message > Subscription

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, `.Message`] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

Possible states for a subscription.