com.google.api.services.pubsub

Class Pubsub.Projects.Snapshots.Patch

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

com.google.api.services.pubsub.Pubsub.Projects.Snapshots.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Pubsub.Projects.Snapshots

public class Pubsub.Projects.Snapshots.Patch
extends PubsubRequest<Snapshot>

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	Patch(String name, UpdateSnapshotRequest content) Updates an existing snapshot.

Method Summary

Modifier and Type	Method and Description
String	getName() The name of the snapshot.
Pubsub.Projects.Snapshots.Patch	set(String parameterName, Object value)
Pubsub.Projects.Snapshots.Patch	set$Xgafv(String $Xgafv) V1 error format.
Pubsub.Projects.Snapshots.Patch	setAccessToken(String accessToken) OAuth access token.
Pubsub.Projects.Snapshots.Patch	setAlt(String alt) Data format for response.
Pubsub.Projects.Snapshots.Patch	setCallback(String callback) JSONP
Pubsub.Projects.Snapshots.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
Pubsub.Projects.Snapshots.Patch	setKey(String key) API key.
Pubsub.Projects.Snapshots.Patch	setName(String name) The name of the snapshot.
Pubsub.Projects.Snapshots.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Pubsub.Projects.Snapshots.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Pubsub.Projects.Snapshots.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Pubsub.Projects.Snapshots.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Pubsub.Projects.Snapshots.Patch	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

Patch

protected Patch(String name,
                UpdateSnapshotRequest content)

Updates an existing snapshot. 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. Create a request for the method "snapshots.patch". 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:

name - The name of the snapshot.

content - the UpdateSnapshotRequest

Since:

1.13

Method Detail

set$Xgafv

public Pubsub.Projects.Snapshots.Patch set$Xgafv(String $Xgafv)

Description copied from class: PubsubRequest

V1 error format.

Overrides:

set$Xgafv in class PubsubRequest<Snapshot>

setAccessToken

public Pubsub.Projects.Snapshots.Patch setAccessToken(String accessToken)

Description copied from class: PubsubRequest

OAuth access token.

Overrides:

setAccessToken in class PubsubRequest<Snapshot>

setAlt

public Pubsub.Projects.Snapshots.Patch setAlt(String alt)

Description copied from class: PubsubRequest

Data format for response.

Overrides:

setAlt in class PubsubRequest<Snapshot>

setCallback

public Pubsub.Projects.Snapshots.Patch setCallback(String callback)

Description copied from class: PubsubRequest

JSONP

Overrides:

setCallback in class PubsubRequest<Snapshot>

setFields

public Pubsub.Projects.Snapshots.Patch setFields(String fields)

Description copied from class: PubsubRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PubsubRequest<Snapshot>

setKey

public Pubsub.Projects.Snapshots.Patch 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<Snapshot>

setOauthToken

public Pubsub.Projects.Snapshots.Patch setOauthToken(String oauthToken)

Description copied from class: PubsubRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PubsubRequest<Snapshot>

setPrettyPrint

public Pubsub.Projects.Snapshots.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: PubsubRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PubsubRequest<Snapshot>

setQuotaUser

public Pubsub.Projects.Snapshots.Patch 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<Snapshot>

setUploadType

public Pubsub.Projects.Snapshots.Patch setUploadType(String uploadType)

Description copied from class: PubsubRequest

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

Overrides:

setUploadType in class PubsubRequest<Snapshot>

setUploadProtocol

public Pubsub.Projects.Snapshots.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: PubsubRequest

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

Overrides:

setUploadProtocol in class PubsubRequest<Snapshot>

getName

public String getName()

The name of the snapshot.

setName

public Pubsub.Projects.Snapshots.Patch setName(String name)

The name of the snapshot.

set

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

Overrides:

set in class PubsubRequest<Snapshot>