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.
Implements
Inherited Members
Namespace: Google.Apis.Pubsub.v1.Data
Assembly: Google.Apis.Pubsub.v1.dll
Syntax
public class Snapshot : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
ExpireTime
object representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }
Property Value
Type | Description |
---|---|
object |
ExpireTimeDateTimeOffset
DateTimeOffset representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
ExpireTimeRaw
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.
Declaration
[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
Labels
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Name
Optional. The name of the snapshot.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Topic
Optional. The name of the topic from which this snapshot is retaining messages.
Declaration
[JsonProperty("topic")]
public virtual string Topic { get; set; }
Property Value
Type | Description |
---|---|
string |