case class ConsumerSettings(groupName: String, offset: Offset = EarliestOffset, consumerId: String = UUID.randomUUID().toString) extends Product with Serializable

Consumer settings object

groupName

name of a consumer group. A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group name multiple processes indicate that they are all part of the same consumer group. Maximum length of this field is 1000 characters.

offset

type of offset used in subscription, detailed information can be found on each Offset subclasses

consumerId

the ID to use to identify this consumer. It must be unique within the consumer group. If you do not provide one, the system will generate one.

See also

group.id.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsumerSettings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConsumerSettings(groupName: String, offset: Offset = EarliestOffset, consumerId: String = UUID.randomUUID().toString)

    groupName

    name of a consumer group. A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group name multiple processes indicate that they are all part of the same consumer group. Maximum length of this field is 1000 characters.

    offset

    type of offset used in subscription, detailed information can be found on each Offset subclasses

    consumerId

    the ID to use to identify this consumer. It must be unique within the consumer group. If you do not provide one, the system will generate one.

Type Members

  1. type ReporterCallback = (AnyRef) => Unit

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. val consumerId: String
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. val groupName: String
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. val offset: Offset
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped