# Cloud Pub/Sub v1 API - Class Subscription (3.36.0)

3.36.0 (latest) 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.1 3.9.1 3.8.0 3.7.0 3.6.0 3.5.1 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0

    public sealed class Subscription : IMessage<Subscription>, IEquatable<Subscription>, IDeepCloneable<Subscription>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class Subscription.

A subscription resource. If none of `push_config`, `bigquery_config`, or
`cloud_storage_config` is set, then the subscriber will pull and ack messages
using API methods. At most one of these fields may be set.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Subscription

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Subscription](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Subscription](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Subscription](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.PubSub.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1)

## Assembly

Google.Cloud.PubSub.V1.dll

## Constructors

### Subscription()

    public Subscription()

### Subscription(Subscription)

    public Subscription(Subscription other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription` |

## Properties

### AckDeadlineSeconds

    public int AckDeadlineSeconds { get; set; }

Optional. 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** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### AnalyticsHubSubscriptionInfo

    public Subscription.Types.AnalyticsHubSubscriptionInfo AnalyticsHubSubscriptionInfo { get; set; }

Output only. Information about the associated Analytics Hub subscription.
Only set if the subscription is created by Analytics Hub.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscriptionhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription.Types.AnalyticsHubSubscriptionInfo` |   |

### BigqueryConfig

    public BigQueryConfig BigqueryConfig { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.BigQueryConfig` |   |

### BigtableConfig

    public BigtableConfig BigtableConfig { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.BigtableConfig` |   |

### CloudStorageConfig

    public CloudStorageConfig CloudStorageConfig { get; set; }

Optional. If delivery to Google Cloud Storage is used with this
subscription, this field is used to configure it.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.CloudStorageConfig` |   |

### DeadLetterPolicy

    public DeadLetterPolicy DeadLetterPolicy { get; set; }

Optional. 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 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** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.DeadLetterPolicy` |   |

### Detached

    public bool Detached { get; set; }

Optional. 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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### EnableExactlyOnceDelivery

    public bool EnableExactlyOnceDelivery { get; set; }

Optional. 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 acknowledgment 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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### EnableMessageOrdering

    public bool EnableMessageOrdering { get; set; }

Optional. 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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### ExpirationPolicy

    public ExpirationPolicy ExpirationPolicy { get; set; }

Optional. 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** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.ExpirationPolicy` |   |

### Filter

    public string Filter { get; set; }

Optional. An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering). 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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Labels

    public MapField<string, string> Labels { get; }

Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### MessageRetentionDuration

    public Duration MessageRetentionDuration { get; set; }

Optional. 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 31 days or less than 10 minutes.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Duration.html` |   |

### MessageTransforms

    public RepeatedField<MessageTransform> MessageTransforms { get; }

Optional. Transforms to be applied to messages before they are delivered to
subscribers. Transforms are applied in the order specified.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.MessageTransform` |   |

### Name

    public string Name { get; set; }

Required. Identifier. 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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### PushConfig

    public PushConfig PushConfig { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.PushConfig` |   |

### RetainAckedMessages

    public bool RetainAckedMessages { get; set; }

Optional. 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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### RetryPolicy

    public RetryPolicy RetryPolicy { get; set; }

Optional. 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 acknowledgment deadline exceeded
events for a given message.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.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** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscriptionhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription.Types.State` |   |

### SubscriptionName

    public SubscriptionName SubscriptionName { get; set; }

[SubscriptionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.SubscriptionName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription#Google_Cloud_PubSub_V1_Subscription_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.SubscriptionName` |   |

### Tags

    public MapField<string, string> Tags { get; }

Optional. Input only. Immutable. Tag keys/values directly bound to this
resource. For example:
"123/environment": "production",
"123/costCenter": "marketing"
See <https://docs.cloud.google.com/pubsub/docs/tags> for more information on
using tags with Pub/Sub resources.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### TopicAsTopicName

    public TopicName TopicAsTopicName { get; set; }

[TopicName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.TopicName)-typed view over the [Topic](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.Subscription#Google_Cloud_PubSub_V1_Subscription_Topic) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Duration.html` |   |