• Home
• com.google.apis
• google-api-services-pubsub
• v1-rev20240918-2.0.0
• source code
• PullRequest.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.pubsub.model.PullRequest.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.pubsub.model
Class PullRequest



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.PullRequest













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class PullRequest
extends com.google.api.client.json.GenericJson
Request 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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


PullRequest() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PullRequest
clone() 


Integer
getMaxMessages()
Required.



Boolean
getReturnImmediately()
Optional.



PullRequest
set(String fieldName,
   Object value) 


PullRequest
setMaxMessages(Integer maxMessages)
Required.



PullRequest
setReturnImmediately(Boolean returnImmediately)
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














Constructor Detail





PullRequest
public PullRequest()









Method Detail





getMaxMessages
public Integer getMaxMessages()
Required. The maximum number of messages to return for this request. Must be a positive
 integer. The Pub/Sub system may return fewer than the number specified.

Returns:
value or null for none








setMaxMessages
public PullRequest setMaxMessages(Integer maxMessages)
Required. The maximum number of messages to return for this request. Must be a positive
 integer. The Pub/Sub system may return fewer than the number specified.

Parameters:
maxMessages - maxMessages or null for none








getReturnImmediately
public Boolean getReturnImmediately()
Optional. If this field set to true, the system will respond immediately even if it there are
 no messages available to return in the `Pull` response. Otherwise, the system may wait (for a
 bounded amount of time) until at least one message is available, rather than returning no
 messages. Warning: setting this field to `true` is discouraged because it adversely impacts the
 performance of `Pull` operations. We recommend that users do not set this field.

Returns:
value or null for none








setReturnImmediately
public PullRequest setReturnImmediately(Boolean returnImmediately)
Optional. If this field set to true, the system will respond immediately even if it there are
 no messages available to return in the `Pull` response. Otherwise, the system may wait (for a
 bounded amount of time) until at least one message is available, rather than returning no
 messages. Warning: setting this field to `true` is discouraged because it adversely impacts the
 performance of `Pull` operations. We recommend that users do not set this field.

Parameters:
returnImmediately - returnImmediately or null for none








set
public PullRequest set(String fieldName,
                       Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public PullRequest clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.