Method: googleapis.pubsub.v1.projects.subscriptions.seek

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. 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. Note that both the subscription and the snapshot must be on the same topic.

Arguments

Parameters
subscription

string

Required. The subscription to affect.

body

object ( SeekRequest )

Required.

Raised exceptions

Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation .

YAML

 - 
  
 seek 
 : 
  
 call 
 : 
  
 googleapis.pubsub.v1.projects.subscriptions.seek 
  
 args 
 : 
  
 subscription 
 : 
  
 ... 
  
 body 
 : 
  
 snapshot 
 : 
  
 ... 
  
 time 
 : 
  
 ... 
  
 result 
 : 
  
 seekResult 

JSON

 [ 
  
 { 
  
 "seek" 
 : 
  
 { 
  
 "call" 
 : 
  
 "googleapis.pubsub.v1.projects.subscriptions.seek" 
 , 
  
 "args" 
 : 
  
 { 
  
 "subscription" 
 : 
  
 "..." 
 , 
  
 "body" 
 : 
  
 { 
  
 "snapshot" 
 : 
  
 "..." 
 , 
  
 "time" 
 : 
  
 "..." 
  
 } 
  
 }, 
  
 "result" 
 : 
  
 "seekResult" 
  
 } 
  
 } 
 ] 
Design a Mobile Site
View Site in Mobile | Classic
Share by: