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 = "", unknownFields: UnknownFieldSet = ...) 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.

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

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 = "", unknownFields: UnknownFieldSet = ...)

    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.

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( ... ) @native() @HotSpotIntrinsicCandidate()
  17. def companion: StreamingPullRequest.type
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  18. def discardUnknownFields: StreamingPullRequest
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val modifyDeadlineAckIds: Seq[String]
  25. val modifyDeadlineSeconds: Seq[Int]
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def serializedSize: Int
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  30. val streamAckDeadlineSeconds: Int
  31. val subscription: String
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  34. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  35. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  36. def toProtoString: String
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  37. val unknownFields: UnknownFieldSet
  38. def update(ms: (Lens[StreamingPullRequest, StreamingPullRequest]) ⇒ Mutation[StreamingPullRequest]*): StreamingPullRequest
    Definition Classes
    Updatable
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def withAckIds(__v: Seq[String]): StreamingPullRequest
  43. def withClientId(__v: String): StreamingPullRequest
  44. def withModifyDeadlineAckIds(__v: Seq[String]): StreamingPullRequest
  45. def withModifyDeadlineSeconds(__v: Seq[Int]): StreamingPullRequest
  46. def withStreamAckDeadlineSeconds(__v: Int): StreamingPullRequest
  47. def withSubscription(__v: String): StreamingPullRequest
  48. def withUnknownFields(__v: UnknownFieldSet): StreamingPullRequest
  49. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  50. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    StreamingPullRequest → GeneratedMessage
  51. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from Updatable[StreamingPullRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped