Class/Object

com.google.pubsub.v1.pubsub

PullRequest

Related Docs: object PullRequest | package pubsub

Permalink

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

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()
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)

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def companion: PullRequest.type

    Permalink
    Definition Classes
    PullRequest → GeneratedMessage

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    PullRequest → GeneratedMessage

  11. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    PullRequest → GeneratedMessage

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. val maxMessages: Int

    Permalink

    Required.

    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.

  14. def mergeFrom(_input__: CodedInputStream): PullRequest

    Permalink
    Definition Classes
    PullRequest → Message

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def serializedSize: Int

    Permalink
    Definition Classes
    PullRequest → GeneratedMessage

  19. val subscription: String

    Permalink

    Required.

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

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  21. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage

  22. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage

  23. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage

  24. def toProtoString: String

    Permalink
    Definition Classes
    PullRequest → GeneratedMessage

  25. def update(ms: (Lens[PullRequest, PullRequest]) ⇒ Mutation[PullRequest]*): PullRequest

    Permalink
    Definition Classes
    Updatable

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def withMaxMessages(__v: Int): PullRequest

    Permalink

  30. def withReturnImmediately(__v: Boolean): PullRequest

    Permalink

  31. def withSubscription(__v: String): PullRequest

    Permalink

  32. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

  33. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    PullRequest → GeneratedMessage

  34. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

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

  3. val returnImmediately: Boolean

    Permalink

    Optional.

    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.

    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

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