kafka.producer

ProducerConfig

class ProducerConfig extends ZKConfig with AsyncProducerConfigShared with SyncProducerConfigShared

Inherited
  1. Hide All
  2. Show all
  1. SyncProducerConfigShared
  2. AsyncProducerConfigShared
  3. ZKConfig
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new ProducerConfig(props: Properties)

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  9. val batchSize: Int

    the number of messages batched at the producer

    the number of messages batched at the producer

    definition classes: AsyncProducerConfigShared
  10. val brokerList: String

    For bypassing zookeeper based auto partition discovery, use this config * to pass in static broker and per-broker partition information.

    For bypassing zookeeper based auto partition discovery, use this config * to pass in static broker and per-broker partition information. Format- * brokerid1:host1:port1, brokerid2:host2:port2

  11. val bufferSize: Int

    definition classes: SyncProducerConfigShared
  12. val cbkHandler: String

    the callback handler for one or multiple events

    the callback handler for one or multiple events

    definition classes: AsyncProducerConfigShared
  13. val cbkHandlerProps: Properties

    properties required to initialize the callback handler

    properties required to initialize the callback handler

    definition classes: AsyncProducerConfigShared
  14. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  15. val compressedTopics: Seq[String]

    This parameter allows you to set whether compression should be turned * on for particular topics

    This parameter allows you to set whether compression should be turned * on for particular topics

    If the compression codec is anything other than NoCompressionCodec,

    Enable compression only for specified topics if any

    If the list of compressed topics is empty, then enable the specified compression codec for all topics

    If the compression codec is NoCompressionCodec, compression is disabled for all topics

  16. val compressionCodec: CompressionCodec

    This parameter allows you to specify the compression codec for all data generated * by this producer.

    This parameter allows you to specify the compression codec for all data generated * by this producer. The default is NoCompressionCodec

  17. val connectTimeoutMs: Int

    definition classes: SyncProducerConfigShared
  18. val enqueueTimeoutMs: Int

    Timeout for event enqueue: 0: events will be enqueued immediately or dropped if the queue is full -ve: enqueue will block indefinitely if the queue is full +ve: enqueue will block up to this many milliseconds if the queue is full

    Timeout for event enqueue: 0: events will be enqueued immediately or dropped if the queue is full -ve: enqueue will block indefinitely if the queue is full +ve: enqueue will block up to this many milliseconds if the queue is full

    definition classes: AsyncProducerConfigShared
  19. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  20. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  21. val eventHandler: String

    the handler for events

    the handler for events

    definition classes: AsyncProducerConfigShared
  22. val eventHandlerProps: Properties

    properties required to initialize the callback handler

    properties required to initialize the callback handler

    definition classes: AsyncProducerConfigShared
  23. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  24. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  25. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  26. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  27. val maxMessageSize: Int

    definition classes: SyncProducerConfigShared
  28. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  29. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  30. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  31. val numRetries: Int

    If DefaultEventHandler is used, this specifies the number of times to retry if an error is encountered during send.

    If DefaultEventHandler is used, this specifies the number of times to retry if an error is encountered during send. Currently, it is only appropriate when broker.list points to a VIP. If the zk.connect option is used instead, this will not have any effect because with the zk-based producer, brokers are not re-selected upon retry. So retries would go to the same (potentially still down) broker. (KAFKA-253 will help address this.)

  32. val partitionerClass: String

    the partitioner class for partitioning events amongst sub-topics

    the partitioner class for partitioning events amongst sub-topics

  33. val producerType: String

    this parameter specifies whether the messages are sent asynchronously * or not.

    this parameter specifies whether the messages are sent asynchronously * or not. Valid values are - async for asynchronous send * sync for synchronous send

  34. val props: Properties

  35. val queueSize: Int

    the maximum size of the blocking queue for buffering on the producer

    the maximum size of the blocking queue for buffering on the producer

    definition classes: AsyncProducerConfigShared
  36. val queueTime: Int

    definition classes: AsyncProducerConfigShared
  37. val reconnectInterval: Int

    definition classes: SyncProducerConfigShared
  38. var reconnectTimeInterval: Int

    negative reconnect time interval means disabling this time-based reconnect feature

    negative reconnect time interval means disabling this time-based reconnect feature

    definition classes: SyncProducerConfigShared
  39. val serializerClass: String

    the serializer class for events

    the serializer class for events

    definition classes: AsyncProducerConfigShared
  40. val socketTimeoutMs: Int

    the socket timeout for network requests

    the socket timeout for network requests

    definition classes: SyncProducerConfigShared
  41. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  42. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  43. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  44. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  45. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  46. val zkConnect: String

    ZK host string

    ZK host string

    definition classes: ZKConfig
  47. val zkConnectionTimeoutMs: Int

    the max time that the client waits to establish a connection to zookeeper

    the max time that the client waits to establish a connection to zookeeper

    definition classes: ZKConfig
  48. val zkReadRetries: Int

    The producer using the zookeeper software load balancer maintains a ZK cache that gets updated by the zookeeper watcher listeners.

    The producer using the zookeeper software load balancer maintains a ZK cache that gets updated by the zookeeper watcher listeners. During some events like a broker bounce, the producer ZK cache can get into an inconsistent state, for a small time period. In this time period, it could end up picking a broker partition that is unavailable. When this happens, the ZK cache needs to be updated. This parameter specifies the number of times the producer attempts to refresh this ZK cache.

  49. val zkSessionTimeoutMs: Int

    zookeeper session timeout

    zookeeper session timeout

    definition classes: ZKConfig
  50. val zkSyncTimeMs: Int

    how far a ZK follower can be behind a ZK leader

    how far a ZK follower can be behind a ZK leader

    definition classes: ZKConfig