Class

com.sksamuel.elastic4s.searches

HighlightField

Related Doc: package searches

Permalink

case class HighlightField(field: String, boundaryChars: Option[Array[Char]] = None, boundaryMaxScan: Option[Int] = None, forceSource: Option[Boolean] = None, fragmenter: Option[String] = None, fragmentOffset: Option[Int] = None, fragmentSize: Option[Int] = None, highlighterType: Option[String] = None, highlightFilter: Option[Boolean] = None, highlightQuery: Option[Query] = None, order: Option[String] = None, noMatchSize: Option[Int] = None, numOfFragments: Option[Int] = None, postTags: Seq[String] = Nil, preTags: Seq[String] = Nil, requireFieldMatch: Option[Boolean] = None, matchedFields: Seq[String] = Nil, phraseLimit: Option[Int] = None, boundaryScanner: Option[String] = None, boundaryScannerLocale: Option[String] = 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. HighlightField
  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 HighlightField(field: String, boundaryChars: Option[Array[Char]] = None, boundaryMaxScan: Option[Int] = None, forceSource: Option[Boolean] = None, fragmenter: Option[String] = None, fragmentOffset: Option[Int] = None, fragmentSize: Option[Int] = None, highlighterType: Option[String] = None, highlightFilter: Option[Boolean] = None, highlightQuery: Option[Query] = None, order: Option[String] = None, noMatchSize: Option[Int] = None, numOfFragments: Option[Int] = None, postTags: Seq[String] = Nil, preTags: Seq[String] = Nil, requireFieldMatch: Option[Boolean] = None, matchedFields: Seq[String] = Nil, phraseLimit: Option[Int] = None, boundaryScanner: Option[String] = None, boundaryScannerLocale: Option[String] = 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(chars: String): HighlightField

    Permalink

  6. def boundaryChars(chars: Array[Char]): HighlightField

    Permalink

  7. val boundaryChars: Option[Array[Char]]

    Permalink

  8. def boundaryMaxScan(boundaryMaxScan: Int): HighlightField

    Permalink

  9. val boundaryMaxScan: Option[Int]

    Permalink

  10. def boundaryScanner(scanner: String): HighlightField

    Permalink

  11. val boundaryScanner: Option[String]

    Permalink

  12. def boundaryScannerLocale(locale: String): HighlightField

    Permalink

  13. val boundaryScannerLocale: Option[String]

    Permalink

  14. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  16. val field: String

    Permalink

  17. def forceSource(forceSource: Boolean): HighlightField

    Permalink

  18. val forceSource: Option[Boolean]

    Permalink

  19. def fragmentOffset(fragmentOffset: Int): HighlightField

    Permalink

  20. val fragmentOffset: Option[Int]

    Permalink

  21. def fragmentSize(fragmentSize: Int): HighlightField

    Permalink

  22. val fragmentSize: Option[Int]

    Permalink

  23. def fragmenter(fragmenter: String): HighlightField

    Permalink

  24. val fragmenter: Option[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  26. def highlightFilter(highlightFilter: Boolean): HighlightField

    Permalink

  27. val highlightFilter: Option[Boolean]

    Permalink

  28. val highlightQuery: Option[Query]

    Permalink

  29. def highlighterType(highlighterType: String): HighlightField

    Permalink

  30. val highlighterType: Option[String]

    Permalink

  31. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  32. def matchedFields(fields: Iterable[String]): HighlightField

    Permalink

  33. def matchedFields(first: String, rest: String*): HighlightField

    Permalink

  34. val matchedFields: Seq[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  36. def noMatchSize(noMatchSize: Int): HighlightField

    Permalink

  37. val noMatchSize: Option[Int]

    Permalink

  38. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  39. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  40. val numOfFragments: Option[Int]

    Permalink

  41. def numberOfFragments(numOfFragments: Int): HighlightField

    Permalink

  42. def options(newOptions: Map[String, AnyRef]): HighlightField

    Permalink

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

    Permalink

  44. def order(order: String): HighlightField

    Permalink

  45. val order: Option[String]

    Permalink

  46. def phraseLimit(limit: Int): HighlightField

    Permalink

  47. val phraseLimit: Option[Int]

    Permalink

  48. def postTag(tags: Iterable[String]): HighlightField

    Permalink

  49. def postTag(tags: String*): HighlightField

    Permalink

  50. val postTags: Seq[String]

    Permalink

  51. def preTag(tags: Iterable[String]): HighlightField

    Permalink

  52. def preTag(tags: String*): HighlightField

    Permalink

  53. val preTags: Seq[String]

    Permalink

  54. def query(query: Query): HighlightField

    Permalink

  55. def requireFieldMatch(requireFieldMatch: Boolean): HighlightField

    Permalink

  56. val requireFieldMatch: Option[Boolean]

    Permalink

  57. def requireFieldMatchScan(req: Boolean): HighlightField

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

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

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

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

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

  61. 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