target.apidocs.com.google.api.services.pubsub.Pubsub.Projects.Subscriptions.Pull.html Maven / Gradle / Ivy
Pubsub.Projects.Subscriptions.Pull (Cloud Pub/Sub API v1-rev20240918-2.0.0)
com.google.api.services.pubsub
Class Pubsub.Projects.Subscriptions.Pull
- 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<PullResponse>
-
- com.google.api.services.pubsub.Pubsub.Projects.Subscriptions.Pull
-
- 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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Pull(String subscription,
PullRequest content)
Pulls messages from the server.
-
Method Summary
-
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
-
Pull
protected Pull(String subscription,
PullRequest content)
Pulls messages from the server.
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(String $Xgafv)
Description copied from class: PubsubRequest
V1 error format.
- Overrides:
set$Xgafv in class PubsubRequest<PullResponse>
-
setAccessToken
public Pubsub.Projects.Subscriptions.Pull setAccessToken(String accessToken)
Description copied from class: PubsubRequest
OAuth access token.
- Overrides:
setAccessToken in class PubsubRequest<PullResponse>
-
setAlt
public Pubsub.Projects.Subscriptions.Pull setAlt(String alt)
Description copied from class: PubsubRequest
Data format for response.
- Overrides:
setAlt in class PubsubRequest<PullResponse>
-
setCallback
public Pubsub.Projects.Subscriptions.Pull setCallback(String callback)
Description copied from class: PubsubRequest
JSONP
- Overrides:
setCallback in class PubsubRequest<PullResponse>
-
setFields
public Pubsub.Projects.Subscriptions.Pull setFields(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(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(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(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(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(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(String uploadProtocol)
Description copied from class: PubsubRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class PubsubRequest<PullResponse>
-
getSubscription
public String getSubscription()
Required. The subscription from which messages should be pulled. Format is
`projects/{project}/subscriptions/{sub}`.
-
setSubscription
public Pubsub.Projects.Subscriptions.Pull setSubscription(String subscription)
Required. The subscription from which messages should be pulled. Format is
`projects/{project}/subscriptions/{sub}`.
-
set
public Pubsub.Projects.Subscriptions.Pull set(String parameterName,
Object value)
- Overrides:
set in class PubsubRequest<PullResponse>
Copyright © 2011–2024 Google. All rights reserved.