Pubsub.Projects.Subscriptions.Pull (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<PullResponse>
        
        com.google.api.services.pubsub.Pubsub.Projects.Subscriptions.Pull

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Pubsub.Projects.Subscriptions
```
public class Pubsub.Projects.Subscriptions.Pull
extends PubsubRequest<PullResponse>
```

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 Pull(java.lang.String subscription, PullRequest content)
Pulls messages from the server.

Constructors
Modifier	Constructor and Description
`protected`	`Pull(java.lang.String subscription, PullRequest content)` Pulls messages from the server.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getSubscription()` Required.
`Pubsub.Projects.Subscriptions.Pull`	`set(java.lang.String parameterName, java.lang.Object value)`
`Pubsub.Projects.Subscriptions.Pull`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Pubsub.Projects.Subscriptions.Pull`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Pubsub.Projects.Subscriptions.Pull`	`setAlt(java.lang.String alt)` Data format for response.
`Pubsub.Projects.Subscriptions.Pull`	`setCallback(java.lang.String callback)` JSONP
`Pubsub.Projects.Subscriptions.Pull`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Pubsub.Projects.Subscriptions.Pull`	`setKey(java.lang.String key)` API key.
`Pubsub.Projects.Subscriptions.Pull`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Pubsub.Projects.Subscriptions.Pull`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Pubsub.Projects.Subscriptions.Pull`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Pubsub.Projects.Subscriptions.Pull`	`setSubscription(java.lang.String subscription)` Required.
`Pubsub.Projects.Subscriptions.Pull`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Pubsub.Projects.Subscriptions.Pull`	`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
  - Pull
```
protected Pull(java.lang.String subscription,
               PullRequest content)
```
    Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription. Create a request for the method "subscriptions.pull". 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 from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`.
    
    content - the PullRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Pubsub.Projects.Subscriptions.Pull set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: PubsubRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PubsubRequest<PullResponse>
  - setAccessToken
```
public Pubsub.Projects.Subscriptions.Pull setAccessToken(java.lang.String accessToken)
```
    Description copied from class: PubsubRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PubsubRequest<PullResponse>
  - setAlt
```
public Pubsub.Projects.Subscriptions.Pull setAlt(java.lang.String alt)
```
    Description copied from class: PubsubRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PubsubRequest<PullResponse>
  - setCallback
```
public Pubsub.Projects.Subscriptions.Pull setCallback(java.lang.String callback)
```
    Description copied from class: PubsubRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PubsubRequest<PullResponse>
  - setFields
```
public Pubsub.Projects.Subscriptions.Pull 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<PullResponse>
  - setKey
```
public Pubsub.Projects.Subscriptions.Pull 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<PullResponse>
  - setOauthToken
```
public Pubsub.Projects.Subscriptions.Pull setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: PubsubRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PubsubRequest<PullResponse>
  - setPrettyPrint
```
public Pubsub.Projects.Subscriptions.Pull setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: PubsubRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class PubsubRequest<PullResponse>
  - setQuotaUser
```
public Pubsub.Projects.Subscriptions.Pull 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<PullResponse>
  - setUploadType
```
public Pubsub.Projects.Subscriptions.Pull setUploadType(java.lang.String uploadType)
```
    Description copied from class: PubsubRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class PubsubRequest<PullResponse>
  - setUploadProtocol
```
public Pubsub.Projects.Subscriptions.Pull setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: PubsubRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PubsubRequest<PullResponse>
  - getSubscription
```
public java.lang.String getSubscription()
```
    Required. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`.
  - setSubscription
```
public Pubsub.Projects.Subscriptions.Pull setSubscription(java.lang.String subscription)
```
    Required. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`.
  - set
```
public Pubsub.Projects.Subscriptions.Pull set(java.lang.String parameterName,
                                              java.lang.Object value)
```
    Overrides:
    
    set in class PubsubRequest<PullResponse>

Cloud Pub/Sub API v1 (revision 452)

Class Pubsub.Projects.Subscriptions.Pull

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

Pull

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getSubscription

setSubscription

set