final case class PullRequest(subscription: String = "", returnImmediately: Boolean = false, maxMessages: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PullRequest] with Product with Serializable

Request for the Pull method.

subscription

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

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.

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.

Annotations
@SerialVersionUID()
Source
PullRequest.scala
Linear Supertypes
Updatable[PullRequest], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PullRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PullRequest(subscription: String = "", returnImmediately: Boolean = false, maxMessages: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    subscription

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

    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.

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def companion: PullRequest.type
    Definition Classes
    PullRequest → GeneratedMessage
  7. def discardUnknownFields: PullRequest
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PullRequest → GeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PullRequest → GeneratedMessage
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val maxMessages: Int
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. def serializedSize: Int
    Definition Classes
    PullRequest → GeneratedMessage
  20. val subscription: String
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  23. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  24. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  25. def toProtoString: String
    Definition Classes
    PullRequest → GeneratedMessage
  26. val unknownFields: UnknownFieldSet
  27. def update(ms: (Lens[PullRequest, PullRequest]) => Mutation[PullRequest]*): PullRequest
    Definition Classes
    Updatable
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. def withMaxMessages(__v: Int): PullRequest
  32. def withReturnImmediately(__v: Boolean): PullRequest
  33. def withSubscription(__v: String): PullRequest
  34. def withUnknownFields(__v: UnknownFieldSet): PullRequest
  35. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  36. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PullRequest → GeneratedMessage
  37. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val returnImmediately: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from Updatable[PullRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped