Cloud Pub/Sub v1 API - Class SeekRequest (3.10.0-beta01)

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.

Inheritance

object > SeekRequest

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

SeekRequest()

public SeekRequest()

SeekRequest(SeekRequest)

public SeekRequest(SeekRequest other)
Parameter
NameDescription
otherSeekRequest

Properties

HasSnapshot

public bool HasSnapshot { get; }

Gets whether the "snapshot" field is set

Property Value
TypeDescription
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
TypeDescription
string

SnapshotAsSnapshotName

public SnapshotName SnapshotAsSnapshotName { get; set; }

SnapshotName-typed view over the Snapshot resource name property.

Property Value
TypeDescription
SnapshotName

Subscription

public string Subscription { get; set; }

Required. The subscription to affect.

Property Value
TypeDescription
string

SubscriptionAsSubscriptionName

public SubscriptionName SubscriptionAsSubscriptionName { get; set; }

SubscriptionName-typed view over the Subscription resource name property.

Property Value
TypeDescription
SubscriptionName

TargetCase

public SeekRequest.TargetOneofCase TargetCase { get; }
Property Value
TypeDescription
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
TypeDescription
Timestamp