com.google.api.services.pubsub

Class Pubsub.Projects.Snapshots.Delete

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Pubsub.Projects.Snapshots

public class Pubsub.Projects.Snapshots.Delete
extends PubsubRequest<Empty>

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	Delete(String snapshot) Removes an existing snapshot.

Method Summary

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

Delete

protected Delete(String snapshot)

Removes an existing snapshot. 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified. Create a request for the method "snapshots.delete". 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:

snapshot - Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: PubsubRequest

V1 error format.

Overrides:

set$Xgafv in class PubsubRequest<Empty>

setAccessToken

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

Description copied from class: PubsubRequest

OAuth access token.

Overrides:

setAccessToken in class PubsubRequest<Empty>

setAlt

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

Description copied from class: PubsubRequest

Data format for response.

Overrides:

setAlt in class PubsubRequest<Empty>

setCallback

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

Description copied from class: PubsubRequest

JSONP

Overrides:

setCallback in class PubsubRequest<Empty>

setFields

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

Description copied from class: PubsubRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PubsubRequest<Empty>

setKey

public Pubsub.Projects.Snapshots.Delete 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<Empty>

setOauthToken

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

Description copied from class: PubsubRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PubsubRequest<Empty>

setPrettyPrint

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

Description copied from class: PubsubRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PubsubRequest<Empty>

setQuotaUser

public Pubsub.Projects.Snapshots.Delete 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<Empty>

setUploadType

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

Description copied from class: PubsubRequest

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

Overrides:

setUploadType in class PubsubRequest<Empty>

setUploadProtocol

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

Description copied from class: PubsubRequest

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

Overrides:

setUploadProtocol in class PubsubRequest<Empty>

getSnapshot

public String getSnapshot()

Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.

setSnapshot

public Pubsub.Projects.Snapshots.Delete setSnapshot(String snapshot)

Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.

set

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

Overrides:

set in class PubsubRequest<Empty>