Class

io.scalajs.npm.kafkanode

ConsumerGroupOptions

Related Doc: package kafkanode

Permalink

class ConsumerGroupOptions extends Object

Consumer Group Options

Annotations
@RawJSType() @ScalaJSDefined()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsumerGroupOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConsumerGroupOptions(batch: UndefOr[String] = js.undefined, fromOffset: UndefOr[String] = js.undefined, host: UndefOr[String] = js.undefined, groupId: UndefOr[String] = js.undefined, outOfRangeOffset: UndefOr[|[String, Array[String]]] = js.undefined, migrateHLC: UndefOr[Boolean] = js.undefined, migrateRolling: UndefOr[Boolean] = js.undefined, protocol: UndefOr[Array[String]] = js.undefined, sessionTimeout: UndefOr[Int] = js.undefined, ssl: UndefOr[Boolean] = js.undefined, zk: UndefOr[RawOptions] = js.undefined)

    Permalink

    batch

    put client batch settings if you need them (see Client)

    fromOffset

    Offsets to use for new groups other options could be 'earliest' or 'none' (none will emit an error if no offsets were saved) equivalent to Java client's auto.offset.reset

    host

    the Zookeeper host(s) (e.g. 'zookeeper:2181')

    groupId

    e.g. 'ExampleTestGroup'

    outOfRangeOffset

    how to recover from OutOfRangeOffset error (where save offset is past server retention) accepts same value as fromOffset

    migrateHLC

    for details please see Migration section below

    migrateRolling

    true or false

    protocol

    An array of partition assignment protocols ordered by preference. 'roundrobin' or 'range' string for built ins (see below to pass in custom assignment protocol)

    sessionTimeout

    e.g. 15000

    ssl

    optional (defaults to false) or tls options hash

    zk

    put client zk settings if you need them (see Client)

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  5. var batch: UndefOr[String]

    Permalink

    put client batch settings if you need them (see Client)

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. var fromOffset: UndefOr[String]

    Permalink

    Offsets to use for new groups other options could be 'earliest' or 'none' (none will emit an error if no offsets were saved) equivalent to Java client's auto.offset.reset

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. var groupId: UndefOr[String]

    Permalink

    e.g.

    e.g. 'ExampleTestGroup'

  13. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. var host: UndefOr[String]

    Permalink

    the Zookeeper host(s) (e.g.

    the Zookeeper host(s) (e.g. 'zookeeper:2181')

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  18. var migrateHLC: UndefOr[Boolean]

    Permalink

    for details please see Migration section below

  19. var migrateRolling: UndefOr[Boolean]

    Permalink

    true or false

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. var outOfRangeOffset: UndefOr[|[String, Array[String]]]

    Permalink

    how to recover from OutOfRangeOffset error (where save offset is past server retention) accepts same value as fromOffset

  24. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  25. var protocol: UndefOr[Array[String]]

    Permalink

    An array of partition assignment protocols ordered by preference.

    An array of partition assignment protocols ordered by preference. 'roundrobin' or 'range' string for built ins (see below to pass in custom assignment protocol)

  26. var sessionTimeout: UndefOr[Int]

    Permalink

    e.g.

    e.g. 15000

  27. var ssl: UndefOr[Boolean]

    Permalink

    optional (defaults to false) or tls options hash

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

    Permalink
    Definition Classes
    AnyRef
  29. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  32. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. var zk: UndefOr[RawOptions]

    Permalink

    put client zk settings if you need them (see Client)

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped