Class Subscription (2.3.0)

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

A subscription resource.

Inheritance

System.Object > Subscription

Implements

Google.Protobuf.IMessage<Subscription>, System.IEquatable<Subscription>, Google.Protobuf.IDeepCloneable<Subscription>, Google.Protobuf.IBufferMessage, Google.Protobuf.IMessage

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace

Google.Cloud.PubSub.V1

Assembly

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 <i>outstanding</i>. 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
`System.Int32`

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
`System.Boolean`

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
`System.Boolean`

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.

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
`System.String`

Labels

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

See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.

Property Value
Type	Description
`Google.Protobuf.Collections.MapField<System.String, System.String>`

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
`Google.Protobuf.WellKnownTypes.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
`System.String`

PushConfig

public PushConfig PushConfig { get; set; }

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.

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.

Property Value
Type	Description
`System.Boolean`

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`

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
`System.String`

TopicAsTopicName

public TopicName TopicAsTopicName { get; set; }

TopicName-typed view over the Topic resource name property.

Property Value
Type	Description
`TopicName`