public sealed class Snapshot : IMessage<Snapshot>, IEquatable<Snapshot>, IDeepCloneable<Snapshot>, IBufferMessage, IMessage
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
System.Object >
Snapshot
Implements
Google.Protobuf.IMessage<Snapshot>,
System.IEquatable<Snapshot>,
Google.Protobuf.IDeepCloneable<Snapshot>,
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
Snapshot()
Snapshot(Snapshot)
public Snapshot(Snapshot other)
Properties
ExpireTime
public Timestamp ExpireTime { get; set; }
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 |
Google.Protobuf.WellKnownTypes.Timestamp | |
Labels
public MapField<string, string> Labels { get; }
| Property Value |
|---|
| Type | Description |
Google.Protobuf.Collections.MapField<System.String, System.String> | |
Name
public string Name { get; set; }
The name of the snapshot.
| Property Value |
|---|
| Type | Description |
System.String | |
SnapshotName
public SnapshotName SnapshotName { get; set; }
Topic
public string Topic { get; set; }
The name of the topic from which this snapshot is retaining messages.
| Property Value |
|---|
| Type | Description |
System.String | |
TopicAsTopicName
public TopicName TopicAsTopicName { get; set; }
