proto-google-cloud-pubsub-v1-scalapb_0.11/com.google.pubsub.v1.pubsub/PullRequest

PullRequest

@SerialVersionUID(0L) final case
class PullRequest(subscription: String, returnImmediately: Boolean, maxMessages: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[PullRequest]

Request for the Pull method.

Value Params
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.

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.

subscription

Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.

Companion
object
trait Updatable[PullRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override
def serializedSize: Int
Definition Classes
GeneratedMessage
def toProtoString: String
def withMaxMessages(`__v`: Int): PullRequest
def withReturnImmediately(`__v`: Boolean): PullRequest
def withSubscription(`__v`: String): PullRequest
def withUnknownFields(`__v`: UnknownFieldSet): PullRequest
def writeTo(`_output__`: CodedOutputStream): Unit

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
final
def toByteArray: Array[Byte]

Serializes the messgae and returns a byte array containing its raw bytes

Serializes the messgae and returns a byte array containing its raw bytes

Inherited from
GeneratedMessage
final
def toByteString: ByteString

Serializes the messgae and returns a ByteString containing its raw bytes

Serializes the messgae and returns a ByteString containing its raw bytes

Inherited from
GeneratedMessage
final
def toPMessage: PMessage
Inherited from
GeneratedMessage
def update(ms: Lens[PullRequest, PullRequest] => () => PullRequest*): PullRequest
Inherited from
Updatable
final
def writeDelimitedTo(output: OutputStream): Unit
Inherited from
GeneratedMessage
final
def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from
GeneratedMessage