Class AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.SeekRequest

Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
PubsubLiteBaseServiceRequest<Operation>
AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.SeekRequest
Implements
Inherited Members
Namespace: Google.Apis.PubsubLite.v1
Assembly: Google.Apis.PubsubLite.v1.dll
Syntax
public class AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.SeekRequest : PubsubLiteBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

SeekRequest(IClientService, SeekSubscriptionRequest, string)

Constructs a new Seek request.

Declaration
public SeekRequest(IClientService service, SeekSubscriptionRequest body, string name)
Parameters
Type Name Description
IClientService service
SeekSubscriptionRequest body
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

Required. The name of the subscription to seek.

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes Seek parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements