public sealed class SeekRequest : IMessage<SeekRequest>, IEquatable<SeekRequest>, IDeepCloneable<SeekRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Pub/Sub v1 API class SeekRequest.
Request for the Seek
method.
Implements
IMessageSeekRequest, IEquatableSeekRequest, IDeepCloneableSeekRequest, IBufferMessage, IMessageNamespace
Google.Cloud.PubSub.V1Assembly
Google.Cloud.PubSub.V1.dll
Constructors
SeekRequest()
public SeekRequest()
SeekRequest(SeekRequest)
public SeekRequest(SeekRequest other)
Parameter | |
---|---|
Name | Description |
other |
SeekRequest |
Properties
HasSnapshot
public bool HasSnapshot { get; }
Gets whether the "snapshot" field is set
Property Value | |
---|---|
Type | Description |
bool |
Snapshot
public string Snapshot { get; set; }
Optional. The snapshot to seek to. The snapshot's topic must be the same
as that of the provided subscription. Format is
projects/{project}/snapshots/{snap}
.
Property Value | |
---|---|
Type | Description |
string |
SnapshotAsSnapshotName
public SnapshotName SnapshotAsSnapshotName { get; set; }
SnapshotName-typed view over the Snapshot resource name property.
Property Value | |
---|---|
Type | Description |
SnapshotName |
Subscription
public string Subscription { get; set; }
Required. The subscription to affect.
Property Value | |
---|---|
Type | Description |
string |
SubscriptionAsSubscriptionName
public SubscriptionName SubscriptionAsSubscriptionName { get; set; }
SubscriptionName-typed view over the Subscription resource name property.
Property Value | |
---|---|
Type | Description |
SubscriptionName |
TargetCase
public SeekRequest.TargetOneofCase TargetCase { get; }
Property Value | |
---|---|
Type | Description |
SeekRequestTargetOneofCase |
Time
public Timestamp Time { get; set; }
Optional. The time to seek to.
Messages retained in the subscription that were published before this
time are marked as acknowledged, and messages retained in the
subscription that were published after this time are marked as
unacknowledged. Note that this operation affects only those messages
retained in the subscription (configured by the combination of
message_retention_duration
and retain_acked_messages
). For example,
if time
corresponds to a point before the message retention
window (or to a point before the system's notion of the subscription
creation time), only retained messages will be marked as unacknowledged,
and already-expunged messages will not be restored.
Property Value | |
---|---|
Type | Description |
Timestamp |