com.sksamuel.elastic4s.streams

SubscriberConfig

case class SubscriberConfig(batchSize: Int = 100, concurrentRequests: Int = 5, refreshAfterOp: Boolean = false, listener: ResponseListener = ResponseListener.noop, completionFn: () ⇒ Unit = (() => ()), errorFn: (Throwable) ⇒ Unit = ((e: Throwable) => ()), failureWait: FiniteDuration = ..., maxAttempts: Int = 5, flushInterval: Option[FiniteDuration] = scala.None, flushAfter: Option[FiniteDuration] = scala.None) extends Product with Serializable

batchSize

the number of elements to group together per batch aside from the last batch

concurrentRequests

the number of concurrent batch operations

refreshAfterOp

if the index should be refreshed after each bulk operation

listener

a listener which is notified on each acknowledge batch item

completionFn

a function which is invoked when all sent requests have been acknowledged and the publisher has completed

errorFn

a function which is invoked when there is an error

failureWait

the timeout before re-trying failed requests. Usually a failed request is elasticsearch's way of indicating backpressure, so this parameter determines how long to wait between requests.

maxAttempts

the max number of times to try a request. If it fails too many times it probably isn't back pressure but an error with the document.

flushInterval

used to schedule periodic bulk indexing. This can be set to avoid waiting for a complete batch for a long period of time. It also is used if the publisher will never complete. This ensures that all elements are indexed, even if the last batch size is lower than batch size.

flushAfter

used to schedule an index if no document has been received within the given duration. Once an index is performed (either by this flush value or because docs arrived in time) the flush after schedule is reset.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SubscriberConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SubscriberConfig(batchSize: Int = 100, concurrentRequests: Int = 5, refreshAfterOp: Boolean = false, listener: ResponseListener = ResponseListener.noop, completionFn: () ⇒ Unit = (() => ()), errorFn: (Throwable) ⇒ Unit = ((e: Throwable) => ()), failureWait: FiniteDuration = ..., maxAttempts: Int = 5, flushInterval: Option[FiniteDuration] = scala.None, flushAfter: Option[FiniteDuration] = scala.None)

    batchSize

    the number of elements to group together per batch aside from the last batch

    concurrentRequests

    the number of concurrent batch operations

    refreshAfterOp

    if the index should be refreshed after each bulk operation

    listener

    a listener which is notified on each acknowledge batch item

    completionFn

    a function which is invoked when all sent requests have been acknowledged and the publisher has completed

    errorFn

    a function which is invoked when there is an error

    failureWait

    the timeout before re-trying failed requests. Usually a failed request is elasticsearch's way of indicating backpressure, so this parameter determines how long to wait between requests.

    maxAttempts

    the max number of times to try a request. If it fails too many times it probably isn't back pressure but an error with the document.

    flushInterval

    used to schedule periodic bulk indexing. This can be set to avoid waiting for a complete batch for a long period of time. It also is used if the publisher will never complete. This ensures that all elements are indexed, even if the last batch size is lower than batch size.

    flushAfter

    used to schedule an index if no document has been received within the given duration. Once an index is performed (either by this flush value or because docs arrived in time) the flush after schedule is reset.

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val batchSize: Int

    the number of elements to group together per batch aside from the last batch

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val completionFn: () ⇒ Unit

    a function which is invoked when all sent requests have been acknowledged and the publisher has completed

  10. val concurrentRequests: Int

    the number of concurrent batch operations

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. val errorFn: (Throwable) ⇒ Unit

    a function which is invoked when there is an error

  13. val failureWait: FiniteDuration

    the timeout before re-trying failed requests.

    the timeout before re-trying failed requests. Usually a failed request is elasticsearch's way of indicating backpressure, so this parameter determines how long to wait between requests.

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val flushAfter: Option[FiniteDuration]

    used to schedule an index if no document has been received within the given duration.

    used to schedule an index if no document has been received within the given duration. Once an index is performed (either by this flush value or because docs arrived in time) the flush after schedule is reset.

  16. val flushInterval: Option[FiniteDuration]

    used to schedule periodic bulk indexing.

    used to schedule periodic bulk indexing. This can be set to avoid waiting for a complete batch for a long period of time. It also is used if the publisher will never complete. This ensures that all elements are indexed, even if the last batch size is lower than batch size.

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

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

    Definition Classes
    Any
  19. val listener: ResponseListener

    a listener which is notified on each acknowledge batch item

  20. val maxAttempts: Int

    the max number of times to try a request.

    the max number of times to try a request. If it fails too many times it probably isn't back pressure but an error with the document.

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

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. val refreshAfterOp: Boolean

    if the index should be refreshed after each bulk operation

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

    Definition Classes
    AnyRef
  26. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped