final case class StreamingPullRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.Seq.empty, modifyDeadlineSeconds: Seq[Int] = _root_.scala.Seq.empty, modifyDeadlineAckIds: Seq[String] = _root_.scala.Seq.empty, streamAckDeadlineSeconds: Int = 0, clientId: String = "", maxOutstandingMessages: Long = 0L, maxOutstandingBytes: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StreamingPullRequest] with Product with Serializable

Request for the StreamingPull streaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgements and ack deadline modifications from the client to the server.

subscription

Required. The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server. Format is projects/{project}/subscriptions/{sub}.

ackIds

List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

modifyDeadlineSeconds

The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.

modifyDeadlineAckIds

List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

streamAckDeadlineSeconds

Required. The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

clientId

A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.

maxOutstandingMessages

Flow control settings for the maximum number of outstanding messages. When there are max_outstanding_messages or more currently sent to the streaming pull client that have not yet been acked or nacked, the server stops sending more messages. The sending of messages resumes once the number of outstanding messages is less than this value. If the value is <= 0, there is no limit to the number of outstanding messages. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

maxOutstandingBytes

Flow control settings for the maximum number of outstanding bytes. When there are max_outstanding_bytes or more worth of messages currently sent to the streaming pull client that have not yet been acked or nacked, the server will stop sending more messages. The sending of messages resumes once the number of outstanding bytes is less than this value. If the value is <= 0, there is no limit to the number of outstanding bytes. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

Annotations
@SerialVersionUID()
Source
StreamingPullRequest.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamingPullRequest
  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 StreamingPullRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.Seq.empty, modifyDeadlineSeconds: Seq[Int] = _root_.scala.Seq.empty, modifyDeadlineAckIds: Seq[String] = _root_.scala.Seq.empty, streamAckDeadlineSeconds: Int = 0, clientId: String = "", maxOutstandingMessages: Long = 0L, maxOutstandingBytes: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    subscription

    Required. The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server. Format is projects/{project}/subscriptions/{sub}.

    ackIds

    List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

    modifyDeadlineSeconds

    The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.

    modifyDeadlineAckIds

    List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

    streamAckDeadlineSeconds

    Required. The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

    clientId

    A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.

    maxOutstandingMessages

    Flow control settings for the maximum number of outstanding messages. When there are max_outstanding_messages or more currently sent to the streaming pull client that have not yet been acked or nacked, the server stops sending more messages. The sending of messages resumes once the number of outstanding messages is less than this value. If the value is <= 0, there is no limit to the number of outstanding messages. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

    maxOutstandingBytes

    Flow control settings for the maximum number of outstanding bytes. When there are max_outstanding_bytes or more worth of messages currently sent to the streaming pull client that have not yet been acked or nacked, the server will stop sending more messages. The sending of messages resumes once the number of outstanding bytes is less than this value. If the value is <= 0, there is no limit to the number of outstanding bytes. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

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. val ackIds: Seq[String]
  5. def addAckIds(__vs: String*): StreamingPullRequest
  6. def addAllAckIds(__vs: Iterable[String]): StreamingPullRequest
  7. def addAllModifyDeadlineAckIds(__vs: Iterable[String]): StreamingPullRequest
  8. def addAllModifyDeadlineSeconds(__vs: Iterable[Int]): StreamingPullRequest
  9. def addModifyDeadlineAckIds(__vs: String*): StreamingPullRequest
  10. def addModifyDeadlineSeconds(__vs: Int*): StreamingPullRequest
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clearAckIds: StreamingPullRequest
  13. def clearModifyDeadlineAckIds: StreamingPullRequest
  14. def clearModifyDeadlineSeconds: StreamingPullRequest
  15. val clientId: String
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  17. def companion: StreamingPullRequest.type
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  18. def discardUnknownFields: StreamingPullRequest
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  23. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val maxOutstandingBytes: Long
  26. val maxOutstandingMessages: Long
  27. val modifyDeadlineAckIds: Seq[String]
  28. val modifyDeadlineSeconds: Seq[Int]
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. def serializedSize: Int
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  34. val streamAckDeadlineSeconds: Int
  35. val subscription: String
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  38. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  39. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  40. def toProtoString: String
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  41. val unknownFields: UnknownFieldSet
  42. def update(ms: (Lens[StreamingPullRequest, StreamingPullRequest]) => Mutation[StreamingPullRequest]*): StreamingPullRequest
    Definition Classes
    Updatable
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. def withAckIds(__v: Seq[String]): StreamingPullRequest
  47. def withClientId(__v: String): StreamingPullRequest
  48. def withMaxOutstandingBytes(__v: Long): StreamingPullRequest
  49. def withMaxOutstandingMessages(__v: Long): StreamingPullRequest
  50. def withModifyDeadlineAckIds(__v: Seq[String]): StreamingPullRequest
  51. def withModifyDeadlineSeconds(__v: Seq[Int]): StreamingPullRequest
  52. def withStreamAckDeadlineSeconds(__v: Int): StreamingPullRequest
  53. def withSubscription(__v: String): StreamingPullRequest
  54. def withUnknownFields(__v: UnknownFieldSet): StreamingPullRequest
  55. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  56. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  57. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped