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
Optional. 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
Optional. 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 ofmodify_deadline_ack_ids
. If it differs the stream will be aborted withINVALID_ARGUMENT
. Each element in this list is applied to the element in the same position inmodify_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 statusINVALID_ARGUMENT
.- modifyDeadlineAckIds
Optional. 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
Optional. 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
Optional. Flow control settings for the maximum number of outstanding messages. When there are
max_outstanding_messages
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 statusINVALID_ARGUMENT
.- maxOutstandingBytes
Optional. 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 statusINVALID_ARGUMENT
.
- Annotations
- @SerialVersionUID()
- Source
- StreamingPullRequest.scala
- Alphabetic
- By Inheritance
- StreamingPullRequest
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
Optional. 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
Optional. 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 ofmodify_deadline_ack_ids
. If it differs the stream will be aborted withINVALID_ARGUMENT
. Each element in this list is applied to the element in the same position inmodify_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 statusINVALID_ARGUMENT
.- modifyDeadlineAckIds
Optional. 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
Optional. 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
Optional. Flow control settings for the maximum number of outstanding messages. When there are
max_outstanding_messages
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 statusINVALID_ARGUMENT
.- maxOutstandingBytes
Optional. 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 statusINVALID_ARGUMENT
.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val ackIds: Seq[String]
- def addAckIds(__vs: String*): StreamingPullRequest
- def addAllAckIds(__vs: Iterable[String]): StreamingPullRequest
- def addAllModifyDeadlineAckIds(__vs: Iterable[String]): StreamingPullRequest
- def addAllModifyDeadlineSeconds(__vs: Iterable[Int]): StreamingPullRequest
- def addModifyDeadlineAckIds(__vs: String*): StreamingPullRequest
- def addModifyDeadlineSeconds(__vs: Int*): StreamingPullRequest
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearAckIds: StreamingPullRequest
- def clearModifyDeadlineAckIds: StreamingPullRequest
- def clearModifyDeadlineSeconds: StreamingPullRequest
- val clientId: String
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: StreamingPullRequest.type
- Definition Classes
- StreamingPullRequest → GeneratedMessage
- def discardUnknownFields: StreamingPullRequest
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- StreamingPullRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- StreamingPullRequest → GeneratedMessage
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxOutstandingBytes: Long
- val maxOutstandingMessages: Long
- val modifyDeadlineAckIds: Seq[String]
- val modifyDeadlineSeconds: Seq[Int]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- StreamingPullRequest → GeneratedMessage
- val streamAckDeadlineSeconds: Int
- val subscription: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- StreamingPullRequest → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[StreamingPullRequest, StreamingPullRequest]) => Mutation[StreamingPullRequest]*): StreamingPullRequest
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAckIds(__v: Seq[String]): StreamingPullRequest
- def withClientId(__v: String): StreamingPullRequest
- def withMaxOutstandingBytes(__v: Long): StreamingPullRequest
- def withMaxOutstandingMessages(__v: Long): StreamingPullRequest
- def withModifyDeadlineAckIds(__v: Seq[String]): StreamingPullRequest
- def withModifyDeadlineSeconds(__v: Seq[Int]): StreamingPullRequest
- def withStreamAckDeadlineSeconds(__v: Int): StreamingPullRequest
- def withSubscription(__v: String): StreamingPullRequest
- def withUnknownFields(__v: UnknownFieldSet): StreamingPullRequest
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- StreamingPullRequest → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage