Class

com.sksamuel.elastic4s.searches

HighlightOptions

Related Doc: package searches

Permalink

case class HighlightOptions(encoder: Option[String] = None, tagsSchema: Option[String] = None, useExplicitFieldOrder: Option[Boolean] = None, boundaryChars: Option[String] = None, boundaryMaxScan: Option[Int] = None, boundaryScanner: Option[String] = None, boundaryScannerLocale: Option[String] = None, fragmenter: Option[String] = None, fragmentSize: Option[Int] = None, forceSource: Option[Boolean] = None, highlighterType: Option[String] = None, highlightFilter: Option[Boolean] = None, highlightQuery: Option[Query] = None, noMatchSize: Option[Int] = None, numOfFragments: Option[Int] = None, order: Option[String] = None, phraseLimit: Option[Int] = None, postTags: Seq[String] = Nil, preTags: Seq[String] = Nil, requireFieldMatch: Option[Boolean] = None, options: Option[Map[String, AnyRef]] = None) extends Product with Serializable

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

Instance Constructors

  1. new HighlightOptions(encoder: Option[String] = None, tagsSchema: Option[String] = None, useExplicitFieldOrder: Option[Boolean] = None, boundaryChars: Option[String] = None, boundaryMaxScan: Option[Int] = None, boundaryScanner: Option[String] = None, boundaryScannerLocale: Option[String] = None, fragmenter: Option[String] = None, fragmentSize: Option[Int] = None, forceSource: Option[Boolean] = None, highlighterType: Option[String] = None, highlightFilter: Option[Boolean] = None, highlightQuery: Option[Query] = None, noMatchSize: Option[Int] = None, numOfFragments: Option[Int] = None, order: Option[String] = None, phraseLimit: Option[Int] = None, postTags: Seq[String] = Nil, preTags: Seq[String] = Nil, requireFieldMatch: Option[Boolean] = None, options: Option[Map[String, AnyRef]] = None)

    Permalink

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. def boundaryChars(boundaryChars: String): HighlightOptions

    Permalink

  6. val boundaryChars: Option[String]

    Permalink

  7. def boundaryMaxScan(boundaryMaxScan: Int): HighlightOptions

    Permalink

  8. val boundaryMaxScan: Option[Int]

    Permalink

  9. def boundaryScanner(boundaryScanner: String): HighlightOptions

    Permalink

  10. val boundaryScanner: Option[String]

    Permalink

  11. def boundaryScannerLocale(locale: String): HighlightOptions

    Permalink

  12. val boundaryScannerLocale: Option[String]

    Permalink

  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  14. def encoder(encoder: String): HighlightOptions

    Permalink

  15. val encoder: Option[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  17. def forceSource(forceSource: Boolean): HighlightOptions

    Permalink

  18. val forceSource: Option[Boolean]

    Permalink

  19. def fragmentSize(fragmentSize: Int): HighlightOptions

    Permalink

  20. val fragmentSize: Option[Int]

    Permalink

  21. def fragmenter(fragmenter: String): HighlightOptions

    Permalink

  22. val fragmenter: Option[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  24. def highlightFilter(highlightFilter: Boolean): HighlightOptions

    Permalink

  25. val highlightFilter: Option[Boolean]

    Permalink

  26. def highlightQuery(highlightQuery: Query): HighlightOptions

    Permalink

  27. val highlightQuery: Option[Query]

    Permalink

  28. def highlighterType(highlighterType: String): HighlightOptions

    Permalink

  29. val highlighterType: Option[String]

    Permalink

  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  32. def noMatchSize(noMatchSize: Int): HighlightOptions

    Permalink

  33. val noMatchSize: Option[Int]

    Permalink

  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  36. def numOfFragments(numOfFragments: Int): HighlightOptions

    Permalink

  37. val numOfFragments: Option[Int]

    Permalink

  38. def options(newOptions: Map[String, AnyRef]): HighlightOptions

    Permalink

  39. val options: Option[Map[String, AnyRef]]

    Permalink

  40. def order(order: String): HighlightOptions

    Permalink

  41. val order: Option[String]

    Permalink

  42. def phraseLimit(phraseLimit: Int): HighlightOptions

    Permalink

  43. val phraseLimit: Option[Int]

    Permalink

  44. def postTags(postTags: Iterable[String]): HighlightOptions

    Permalink

  45. def postTags(first: String, rest: String*): HighlightOptions

    Permalink

  46. val postTags: Seq[String]

    Permalink

  47. def preTags(preTags: Iterable[String]): HighlightOptions

    Permalink

  48. def preTags(first: String, rest: String*): HighlightOptions

    Permalink

  49. val preTags: Seq[String]

    Permalink

  50. def requireFieldMatch(requireFieldMatch: Boolean): HighlightOptions

    Permalink

  51. val requireFieldMatch: Option[Boolean]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  53. def tagsSchema(tagsSchema: String): HighlightOptions

    Permalink

  54. val tagsSchema: Option[String]

    Permalink

  55. def useExplicitFieldOrder(useExplicitFieldOrder: Boolean): HighlightOptions

    Permalink

  56. val useExplicitFieldOrder: Option[Boolean]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  58. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  59. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped