com.google.api.services.pubsub

Class Pubsub.Projects.Topics.Snapshots.List

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<ListTopicSnapshotsResponse>

com.google.api.services.pubsub.Pubsub.Projects.Topics.Snapshots.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Pubsub.Projects.Topics.Snapshots

public class Pubsub.Projects.Topics.Snapshots.List
extends PubsubRequest<ListTopicSnapshotsResponse>

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String topic) Lists the names of the snapshots on this topic.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() Optional.
String	getPageToken() Optional.
String	getTopic() Required.
Pubsub.Projects.Topics.Snapshots.List	set(String parameterName, Object value)
Pubsub.Projects.Topics.Snapshots.List	set$Xgafv(String $Xgafv) V1 error format.
Pubsub.Projects.Topics.Snapshots.List	setAccessToken(String accessToken) OAuth access token.
Pubsub.Projects.Topics.Snapshots.List	setAlt(String alt) Data format for response.
Pubsub.Projects.Topics.Snapshots.List	setCallback(String callback) JSONP
Pubsub.Projects.Topics.Snapshots.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Pubsub.Projects.Topics.Snapshots.List	setKey(String key) API key.
Pubsub.Projects.Topics.Snapshots.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Pubsub.Projects.Topics.Snapshots.List	setPageSize(Integer pageSize) Optional.
Pubsub.Projects.Topics.Snapshots.List	setPageToken(String pageToken) Optional.
Pubsub.Projects.Topics.Snapshots.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Pubsub.Projects.Topics.Snapshots.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Pubsub.Projects.Topics.Snapshots.List	setTopic(String topic) Required.
Pubsub.Projects.Topics.Snapshots.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Pubsub.Projects.Topics.Snapshots.List	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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

List

protected List(String topic)

Lists the names of the snapshots on this topic. 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. Create a request for the method "snapshots.list". 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:

topic - Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListTopicSnapshotsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListTopicSnapshotsResponse>

Throws:

IOException

set$Xgafv

public Pubsub.Projects.Topics.Snapshots.List set$Xgafv(String $Xgafv)

Description copied from class: PubsubRequest

V1 error format.

Overrides:

set$Xgafv in class PubsubRequest<ListTopicSnapshotsResponse>

setAccessToken

public Pubsub.Projects.Topics.Snapshots.List setAccessToken(String accessToken)

Description copied from class: PubsubRequest

OAuth access token.

Overrides:

setAccessToken in class PubsubRequest<ListTopicSnapshotsResponse>

setAlt

public Pubsub.Projects.Topics.Snapshots.List setAlt(String alt)

Description copied from class: PubsubRequest

Data format for response.

Overrides:

setAlt in class PubsubRequest<ListTopicSnapshotsResponse>

setCallback

public Pubsub.Projects.Topics.Snapshots.List setCallback(String callback)

Description copied from class: PubsubRequest

JSONP

Overrides:

setCallback in class PubsubRequest<ListTopicSnapshotsResponse>

setFields

public Pubsub.Projects.Topics.Snapshots.List setFields(String fields)

Description copied from class: PubsubRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PubsubRequest<ListTopicSnapshotsResponse>

setKey

public Pubsub.Projects.Topics.Snapshots.List 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<ListTopicSnapshotsResponse>

setOauthToken

public Pubsub.Projects.Topics.Snapshots.List setOauthToken(String oauthToken)

Description copied from class: PubsubRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PubsubRequest<ListTopicSnapshotsResponse>

setPrettyPrint

public Pubsub.Projects.Topics.Snapshots.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: PubsubRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PubsubRequest<ListTopicSnapshotsResponse>

setQuotaUser

public Pubsub.Projects.Topics.Snapshots.List 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<ListTopicSnapshotsResponse>

setUploadType

public Pubsub.Projects.Topics.Snapshots.List setUploadType(String uploadType)

Description copied from class: PubsubRequest

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

Overrides:

setUploadType in class PubsubRequest<ListTopicSnapshotsResponse>

setUploadProtocol

public Pubsub.Projects.Topics.Snapshots.List setUploadProtocol(String uploadProtocol)

Description copied from class: PubsubRequest

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

Overrides:

setUploadProtocol in class PubsubRequest<ListTopicSnapshotsResponse>

getTopic

public String getTopic()

Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.

setTopic

public Pubsub.Projects.Topics.Snapshots.List setTopic(String topic)

Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.

getPageSize

public Integer getPageSize()

Optional. Maximum number of snapshot names to return.

setPageSize

public Pubsub.Projects.Topics.Snapshots.List setPageSize(Integer pageSize)

Optional. Maximum number of snapshot names to return.

getPageToken

public String getPageToken()

Optional. The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data.

setPageToken

public Pubsub.Projects.Topics.Snapshots.List setPageToken(String pageToken)

Optional. The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data.

set

public Pubsub.Projects.Topics.Snapshots.List set(String parameterName,
                                                 Object value)

Overrides:

set in class PubsubRequest<ListTopicSnapshotsResponse>