Pubsub.Projects.Snapshots.Patch (Cloud Pub/Sub API v1 (Rev. 452) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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(java.lang.String name, UpdateSnapshotRequest content)
Updates an existing snapshot.

Constructors
Modifier	Constructor and Description
`protected`	`Patch(java.lang.String name, UpdateSnapshotRequest content)` Updates an existing snapshot.

Method Summary

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

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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(java.lang.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(java.lang.String $Xgafv)
```
    Description copied from class: PubsubRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PubsubRequest<Snapshot>
  - setAccessToken
```
public Pubsub.Projects.Snapshots.Patch setAccessToken(java.lang.String accessToken)
```
    Description copied from class: PubsubRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PubsubRequest<Snapshot>
  - setAlt
```
public Pubsub.Projects.Snapshots.Patch setAlt(java.lang.String alt)
```
    Description copied from class: PubsubRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PubsubRequest<Snapshot>
  - setCallback
```
public Pubsub.Projects.Snapshots.Patch setCallback(java.lang.String callback)
```
    Description copied from class: PubsubRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PubsubRequest<Snapshot>
  - setFields
```
public Pubsub.Projects.Snapshots.Patch setFields(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String uploadProtocol)
```
    Description copied from class: PubsubRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PubsubRequest<Snapshot>
  - getName
```
public java.lang.String getName()
```
    The name of the snapshot.
  - setName
```
public Pubsub.Projects.Snapshots.Patch setName(java.lang.String name)
```
    The name of the snapshot.
  - set
```
public Pubsub.Projects.Snapshots.Patch set(java.lang.String parameterName,
                                           java.lang.Object value)
```
    Overrides:
    
    set in class PubsubRequest<Snapshot>

Cloud Pub/Sub API v1 (revision 452)

Class Pubsub.Projects.Snapshots.Patch

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Patch

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

set