target.apidocs.com.google.api.services.pubsub.model.SeekRequest.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-pubsub Show documentation

There is a newer version: v1-rev20240730-2.0.0

Show newest version







SeekRequest (Cloud Pub/Sub API v1-rev20240918-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.pubsub.model
Class SeekRequest



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.pubsub.model.SeekRequest













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class SeekRequest
extends com.google.api.client.json.GenericJson
Request for the `Seek` method.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


SeekRequest() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SeekRequest
clone() 


String
getSnapshot()
Optional.



String
getTime()
Optional.



SeekRequest
set(String fieldName,
   Object value) 


SeekRequest
setSnapshot(String snapshot)
Optional.



SeekRequest
setTime(String time)
Optional.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





SeekRequest
public SeekRequest()









Method Detail





getSnapshot
public String getSnapshot()
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}`.

Returns:
value or null for none








setSnapshot
public SeekRequest setSnapshot(String snapshot)
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}`.

Parameters:
snapshot - snapshot or null for none








getTime
public String getTime()
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.

Returns:
value or null for none








setTime
public SeekRequest setTime(String time)
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.

Parameters:
time - time or null for none








set
public SeekRequest set(String fieldName,
                       Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public SeekRequest clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`SeekRequest`	`clone()`
`String`	`getSnapshot()` Optional.
`String`	`getTime()` Optional.
`SeekRequest`	`set(String fieldName, Object value)`
`SeekRequest`	`setSnapshot(String snapshot)` Optional.
`SeekRequest`	`setTime(String time)` Optional.