target.apidocs.com.google.api.services.pubsub.model.PullResponse.html Maven / Gradle / Ivy
PullResponse (Cloud Pub/Sub API v1-rev20240918-2.0.0)
com.google.api.services.pubsub.model
Class PullResponse
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.pubsub.model.PullResponse
-
public final class PullResponse
extends com.google.api.client.json.GenericJson
Response for the `Pull` method.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
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
Constructor and Description
PullResponse()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
PullResponseclone()
List<ReceivedMessage>getReceivedMessages()
Optional.
PullResponseset(String fieldName,
Object value)
PullResponsesetReceivedMessages(List<ReceivedMessage> receivedMessages)
Optional.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
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
-
-
Method Detail
-
getReceivedMessages
public List<ReceivedMessage> getReceivedMessages()
Optional. Received Pub/Sub messages. The list will be empty if there are no more messages
available in the backlog, or if no messages could be returned before the request timeout. For
JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the
`maxMessages` requested even if there are more messages available in the backlog.
- Returns:
- value or
null for none
-
setReceivedMessages
public PullResponse setReceivedMessages(List<ReceivedMessage> receivedMessages)
Optional. Received Pub/Sub messages. The list will be empty if there are no more messages
available in the backlog, or if no messages could be returned before the request timeout. For
JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the
`maxMessages` requested even if there are more messages available in the backlog.
- Parameters:
receivedMessages - receivedMessages or null for none
-
set
public PullResponse set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public PullResponse clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.