com.sksamuel.elastic4s

Hit

trait Hit extends AnyRef

A common trait for Get, MultiGet, Search and MultiSearch API results so that the HitReader typeclass can unmarshall results from any of those.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hit
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def exists: Boolean

  2. abstract def id: String

  3. abstract def index: String

  4. abstract def score: Float

  5. abstract def sourceAsMap: Map[String, AnyRef]

  6. abstract def sourceAsString: String

  7. abstract def type: String

  8. abstract def version: Long

Concrete 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. def clone(): AnyRef

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

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

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

    Definition Classes
    Any
  14. final def isSourceEmpty: Boolean

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

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

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

    Definition Classes
    AnyRef
  18. final def ref: DocumentRef

  19. final def safeTo[T](implicit reader: HitReader[T]): Either[Throwable, T]

    Uses a HitReader typeclass to convert the returned source into type T.

    Uses a HitReader typeclass to convert the returned source into type T. This method will return a Left[Throwable] if there was an error during the marshalling, otherwise it will return a Right[T]

  20. final def safeToOpt[T](implicit arg0: HitReader[T]): Option[Either[Throwable, T]]

  21. final def sourceAsByteBuffer: ByteBuffer

  22. final def sourceAsBytes: Array[Byte]

  23. final def sourceAsMutableMap: Map[String, AnyRef]

  24. final def sourceField(name: String): AnyRef

  25. final def sourceFieldOpt(name: String): Option[AnyRef]

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

    Definition Classes
    AnyRef
  27. final def to[T](implicit arg0: HitReader[T]): T

    Uses a HitReader typeclass to convert the returned source into type T.

    Uses a HitReader typeclass to convert the returned source into type T. This method will throw an exception if the marshalling process fails

  28. final def toOpt[T](implicit arg0: HitReader[T]): Option[T]

    Returns a Some(t) if the hit exists.

    Returns a Some(t) if the hit exists. It might not exist (an empty hit) if this was returned by a Get request and the given id did not exist, in which case it will return None.

  29. def toString(): String

    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped