Cloud Pub/Sub v1 API - Class Snapshot (3.16.0)

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

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

A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Inheritance

object > Snapshot

Implements

IMessage Snapshot, IEquatable Snapshot, IDeepCloneable Snapshot, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

Snapshot()

public Snapshot()

Snapshot(Snapshot)

public Snapshot(Snapshot other)

Parameter
Name	Description
`other`	`Snapshot`

Properties

ExpireTime

public Timestamp ExpireTime { get; set; }

Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

Property Value
Type	Description
`Timestamp`

Labels

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

Optional. See Creating and managing labels.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

Optional. The name of the snapshot.

Property Value
Type	Description
`string`

SnapshotName

public SnapshotName SnapshotName { get; set; }

SnapshotName-typed view over the Name resource name property.

Property Value
Type	Description
`SnapshotName`

Topic

public string Topic { get; set; }

Optional. The name of the topic from which this snapshot is retaining messages.

Property Value
Type	Description
`string`

TopicAsTopicName

public TopicName TopicAsTopicName { get; set; }

TopicName-typed view over the Topic resource name property.

Property Value
Type	Description
`TopicName`