final case class PullRequest(subscription: String = "", returnImmediately: Boolean = false, maxMessages: Int = 0) extends GeneratedMessage with Message[PullRequest] with Updatable[PullRequest] with Product with Serializable

Request for the Pull method.

subscription

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

returnImmediately

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. The client may cancel the request if it does not wish to wait any longer for the response.

maxMessages

The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.

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

Instance Constructors

  1. new PullRequest(subscription: String = "", returnImmediately: Boolean = false, maxMessages: Int = 0)

    subscription

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

    returnImmediately

    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. The client may cancel the request if it does not wish to wait any longer for the response.

    maxMessages

    The maximum number of messages returned for this request. 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  6. def companion: PullRequest.type
    Definition Classes
    PullRequest → GeneratedMessage
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PullRequest → GeneratedMessage
  10. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PullRequest → GeneratedMessage
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val maxMessages: Int
  13. def mergeFrom(_input__: CodedInputStream): PullRequest
    Definition Classes
    PullRequest → Message
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val returnImmediately: Boolean
  18. final def serializedSize: Int
    Definition Classes
    PullRequest → GeneratedMessage
  19. val subscription: String
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  22. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  23. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  24. def toProtoString: String
    Definition Classes
    PullRequest → GeneratedMessage
  25. def update(ms: (Lens[PullRequest, PullRequest]) ⇒ Mutation[PullRequest]*): PullRequest
    Definition Classes
    Updatable
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def withMaxMessages(__v: Int): PullRequest
  30. def withReturnImmediately(__v: Boolean): PullRequest
  31. def withSubscription(__v: String): PullRequest
  32. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  33. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PullRequest → GeneratedMessage
  34. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def getAllFields: Map[FieldDescriptor, Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  3. def getField(field: FieldDescriptor): Any
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[PullRequest]

Inherited from Message[PullRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped