com.google.api.services.pubsub

Class Pubsub.Projects.Subscriptions.Seek

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.pubsub.PubsubRequest<SeekResponse>

com.google.api.services.pubsub.Pubsub.Projects.Subscriptions.Seek

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Pubsub.Projects.Subscriptions

public class Pubsub.Projects.Subscriptions.Seek
extends PubsubRequest<SeekResponse>

Nested Class Summary

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

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Seek(String subscription, SeekRequest content) Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.

Method Summary

Modifier and Type	Method and Description
String	getSubscription() Required.
Pubsub.Projects.Subscriptions.Seek	set(String parameterName, Object value)
Pubsub.Projects.Subscriptions.Seek	set$Xgafv(String $Xgafv) V1 error format.
Pubsub.Projects.Subscriptions.Seek	setAccessToken(String accessToken) OAuth access token.
Pubsub.Projects.Subscriptions.Seek	setAlt(String alt) Data format for response.
Pubsub.Projects.Subscriptions.Seek	setCallback(String callback) JSONP
Pubsub.Projects.Subscriptions.Seek	setFields(String fields) Selector specifying which fields to include in a partial response.
Pubsub.Projects.Subscriptions.Seek	setKey(String key) API key.
Pubsub.Projects.Subscriptions.Seek	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Pubsub.Projects.Subscriptions.Seek	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Pubsub.Projects.Subscriptions.Seek	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Pubsub.Projects.Subscriptions.Seek	setSubscription(String subscription) Required.
Pubsub.Projects.Subscriptions.Seek	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Pubsub.Projects.Subscriptions.Seek	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.pubsub.PubsubRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

Seek

protected Seek(String subscription,
               SeekRequest content)

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] (https://cloud.google.com/pubsub/docs/replay- overview) 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. Create a request for the method "subscriptions.seek". This request holds the parameters needed by the the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Pubsub.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

subscription - Required. The subscription to affect.

content - the SeekRequest

Since:

1.13

Method Detail

set$Xgafv

public Pubsub.Projects.Subscriptions.Seek set$Xgafv(String $Xgafv)

Description copied from class: PubsubRequest

V1 error format.

Overrides:

set$Xgafv in class PubsubRequest<SeekResponse>

setAccessToken

public Pubsub.Projects.Subscriptions.Seek setAccessToken(String accessToken)

Description copied from class: PubsubRequest

OAuth access token.

Overrides:

setAccessToken in class PubsubRequest<SeekResponse>

setAlt

public Pubsub.Projects.Subscriptions.Seek setAlt(String alt)

Description copied from class: PubsubRequest

Data format for response.

Overrides:

setAlt in class PubsubRequest<SeekResponse>

setCallback

public Pubsub.Projects.Subscriptions.Seek setCallback(String callback)

Description copied from class: PubsubRequest

JSONP

Overrides:

setCallback in class PubsubRequest<SeekResponse>

setFields

public Pubsub.Projects.Subscriptions.Seek setFields(String fields)

Description copied from class: PubsubRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PubsubRequest<SeekResponse>

setKey

public Pubsub.Projects.Subscriptions.Seek setKey(String key)

Description copied from class: PubsubRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class PubsubRequest<SeekResponse>

setOauthToken

public Pubsub.Projects.Subscriptions.Seek setOauthToken(String oauthToken)

Description copied from class: PubsubRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PubsubRequest<SeekResponse>

setPrettyPrint

public Pubsub.Projects.Subscriptions.Seek setPrettyPrint(Boolean prettyPrint)

Description copied from class: PubsubRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PubsubRequest<SeekResponse>

setQuotaUser

public Pubsub.Projects.Subscriptions.Seek setQuotaUser(String quotaUser)

Description copied from class: PubsubRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class PubsubRequest<SeekResponse>

setUploadType

public Pubsub.Projects.Subscriptions.Seek setUploadType(String uploadType)

Description copied from class: PubsubRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class PubsubRequest<SeekResponse>

setUploadProtocol

public Pubsub.Projects.Subscriptions.Seek setUploadProtocol(String uploadProtocol)

Description copied from class: PubsubRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class PubsubRequest<SeekResponse>

getSubscription

public String getSubscription()

Required. The subscription to affect.

setSubscription

public Pubsub.Projects.Subscriptions.Seek setSubscription(String subscription)

Required. The subscription to affect.

set

public Pubsub.Projects.Subscriptions.Seek set(String parameterName,
                                              Object value)

Overrides:

set in class PubsubRequest<SeekResponse>