Trait

com.sksamuel.elastic4s

Hit

Related Doc: package elastic4s

Permalink

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
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def exists: Boolean

    Permalink

  2. abstract def id: String

    Permalink

  3. abstract def index: String

    Permalink

  4. abstract def score: Float

    Permalink

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

    Permalink

  6. abstract def sourceAsString: String

    Permalink

  7. abstract def type: String

    Permalink

  8. abstract def version: Long

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  9. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. final def isSourceEmpty: Boolean

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  15. final def ref: DocumentRef

    Permalink

  16. final def safeTo[T](implicit reader: HitReader[T]): Try[T]

    Permalink

    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]

  17. final def safeToOpt[T](implicit arg0: HitReader[T]): Option[Try[T]]

    Permalink

  18. final def sourceAsByteBuffer: ByteBuffer

    Permalink

  19. final def sourceAsBytes: Array[Byte]

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  24. final def to[T](implicit arg0: HitReader[T]): T

    Permalink

    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

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

    Permalink

    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.

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

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

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

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

  29. 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 AnyRef

Inherited from Any

Ungrouped