public sealed class Subscription : IMessage<Subscription>, IEquatable<Subscription>, IDeepCloneable<Subscription>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Pub/Sub v1 API class Subscription.
A subscription resource. If none of push_config or bigquery_config is
set, then the subscriber will pull and ack messages using API methods. At
most one of these fields may be set.
Implements
IMessageSubscription, IEquatableSubscription, IDeepCloneableSubscription, IBufferMessage, IMessageNamespace
Google.Cloud.PubSub.V1Assembly
Google.Cloud.PubSub.V1.dll
Constructors
Subscription()
public Subscription()Subscription(Subscription)
public Subscription(Subscription other)| Parameter | |
|---|---|
| Name | Description |
other | Subscription |
Properties
AckDeadlineSeconds
public int AckDeadlineSeconds { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int | |
BigqueryConfig
public BigQueryConfig BigqueryConfig { get; set; }If delivery to BigQuery is used with this subscription, this field is used to configure it.
| Property Value | |
|---|---|
| Type | Description |
BigQueryConfig | |
DeadLetterPolicy
public DeadLetterPolicy DeadLetterPolicy { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
DeadLetterPolicy | |
Detached
public bool Detached { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
EnableExactlyOnceDelivery
public bool EnableExactlyOnceDelivery { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
EnableMessageOrdering
public bool EnableMessageOrdering { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
ExpirationPolicy
public ExpirationPolicy ExpirationPolicy { get; set; }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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
| Property Value | |
|---|---|
| Type | Description |
ExpirationPolicy | |
Filter
public string Filter { get; set; }An expression written in the Pub/Sub filter
language. If non-empty,
then only PubsubMessages whose attributes field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.
| Property Value | |
|---|---|
| Type | Description |
string | |
Labels
public MapField<string, string> Labels { get; }| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
MessageRetentionDuration
public Duration MessageRetentionDuration { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Duration | |
Name
public string Name { get; set; }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".
| Property Value | |
|---|---|
| Type | Description |
string | |
PushConfig
public PushConfig PushConfig { get; set; }If push delivery is used with this subscription, this field is used to configure it.
| Property Value | |
|---|---|
| Type | Description |
PushConfig | |
RetainAckedMessages
public bool RetainAckedMessages { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
RetryPolicy
public RetryPolicy RetryPolicy { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
RetryPolicy | |
State
public Subscription.Types.State State { get; set; }Output only. An output-only field indicating whether or not the subscription can receive messages.
| Property Value | |
|---|---|
| Type | Description |
SubscriptionTypesState | |
SubscriptionName
public SubscriptionName SubscriptionName { get; set; }SubscriptionName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
SubscriptionName | |
Topic
public string Topic { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
TopicAsTopicName
public TopicName TopicAsTopicName { get; set; }| Property Value | |
|---|---|
| Type | Description |
TopicName | |
TopicMessageRetentionDuration
public Duration TopicMessageRetentionDuration { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Duration | |