Packages

case class ProduceRequest(requiredAcks: RequiredAcks.Value, timeout: FiniteDuration, messages: Vector[(@@[String, TopicName], Vector[(@@[Int, PartitionId], Vector[Message])])]) extends Request with Product with Serializable

The produce API is used to send message sets to the server. For efficiency it allows sending message sets intended for many topic partitions in a single request.

The produce API uses the generic message set format, but since no offset has been assigned to the messages at the time of the send the producer is free to fill in that field in any way it likes.

requiredAcks

This field indicates how many acknowledgements the servers should receive before responding to the request. If it is 0 the server will not send any response (this is the only case where the server will not reply to a request). If it is 1, the server will wait the data is written to the local log before sending a response. If it is -1 the server will block until the message is committed by all in sync replicas before sending a response.

timeout

This provides a maximum time the server can await the receipt of the number of acknowledgements in RequiredAcks. The timeout is not an exact limit on the request time for a few reasons: (1) it does not include network latency, (2) the timer begins at the beginning of the processing of this request so if many requests are queued due to server overload that wait time will not be included, (3) we will not terminate a local write so if the local write time exceeds this timeout it will not be respected. To get a hard timeout of this type the client should use the socket timeout.

messages

Messages, organized by topic and partition

Source
Request.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Request, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProduceRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Request
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProduceRequest(requiredAcks: RequiredAcks.Value, timeout: FiniteDuration, messages: Vector[(@@[String, TopicName], Vector[(@@[Int, PartitionId], Vector[Message])])])

    requiredAcks

    This field indicates how many acknowledgements the servers should receive before responding to the request. If it is 0 the server will not send any response (this is the only case where the server will not reply to a request). If it is 1, the server will wait the data is written to the local log before sending a response. If it is -1 the server will block until the message is committed by all in sync replicas before sending a response.

    timeout

    This provides a maximum time the server can await the receipt of the number of acknowledgements in RequiredAcks. The timeout is not an exact limit on the request time for a few reasons: (1) it does not include network latency, (2) the timer begins at the beginning of the processing of this request so if many requests are queued due to server overload that wait time will not be included, (3) we will not terminate a local write so if the local write time exceeds this timeout it will not be respected. To get a hard timeout of this type the client should use the socket timeout.

    messages

    Messages, organized by topic and partition

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ProduceRequest to any2stringadd[ProduceRequest] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ProduceRequest, B)
    Implicit
    This member is added by an implicit conversion from ProduceRequest to ArrowAssoc[ProduceRequest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (ProduceRequest) ⇒ Boolean, msg: ⇒ Any): ProduceRequest
    Implicit
    This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ProduceRequest) ⇒ Boolean): ProduceRequest
    Implicit
    This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ProduceRequest
    Implicit
    This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ProduceRequest
    Implicit
    This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ProduceRequest to StringFormat[ProduceRequest] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val messages: Vector[(@@[String, TopicName], Vector[(@@[Int, PartitionId], Vector[Message])])]
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. val requiredAcks: RequiredAcks.Value
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. val timeout: FiniteDuration
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def →[B](y: B): (ProduceRequest, B)
    Implicit
    This member is added by an implicit conversion from ProduceRequest to ArrowAssoc[ProduceRequest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Request

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ProduceRequest to any2stringadd[ProduceRequest]

Inherited by implicit conversion StringFormat from ProduceRequest to StringFormat[ProduceRequest]

Inherited by implicit conversion Ensuring from ProduceRequest to Ensuring[ProduceRequest]

Inherited by implicit conversion ArrowAssoc from ProduceRequest to ArrowAssoc[ProduceRequest]

Ungrouped