ProduceRequest

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

Instance Constructors

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ProduceRequest to any2stringadd[ProduceRequest] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (ProduceRequest, B)

Implicit information
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (ProduceRequest) ⇒ Boolean, msg: ⇒ Any): ProduceRequest

Implicit information
This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ProduceRequest) ⇒ Boolean): ProduceRequest

Implicit information
This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ProduceRequest

Implicit information
This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ProduceRequest

Implicit information
This member is added by an implicit conversion from ProduceRequest to Ensuring[ProduceRequest] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val messages: Vector[(@@[String, TopicName], Vector[(@@[Int, PartitionId], Vector[Message])])]

Messages, organized by topic and partition
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val requiredAcks: RequiredAcks.Value

This field indicates how many acknowledgements the servers should receive before responding to the request.
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: FiniteDuration

This provides a maximum time the server can await the receipt of the number of acknowledgements in RequiredAcks.
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.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (ProduceRequest, B)

Implicit information
This member is added by an implicit conversion from ProduceRequest to ArrowAssoc[ProduceRequest] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Doc: package Request

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

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ProduceRequest, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (ProduceRequest) ⇒ Boolean, msg: ⇒ Any): ProduceRequest

def ensuring(cond: (ProduceRequest) ⇒ Boolean): ProduceRequest

def ensuring(cond: Boolean, msg: ⇒ Any): ProduceRequest

def ensuring(cond: Boolean): ProduceRequest

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val messages: Vector[(@@[String, TopicName], Vector[(@@[Int, PartitionId], Vector[Message])])]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val requiredAcks: RequiredAcks.Value

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

val timeout: FiniteDuration

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (ProduceRequest, B)

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