Interface ScrollableHitSource.Hit

  • All Known Implementing Classes:
    ScrollableHitSource.BasicHit
    Enclosing class:
    ScrollableHitSource

    public static interface ScrollableHitSource.Hit
    A document returned as part of the response. Think of it like SearchHit but with all the things reindex needs in convenient methods.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getId()
      The document id of the hit.
      java.lang.String getIndex()
      The index in which the hit is stored.
      java.lang.String getParent()
      The document id of the parent of the hit if there is a parent or null if there isn't.
      java.lang.String getRouting()
      The routing on the hit if there is any or null if there isn't.
      BytesReference getSource()
      The source of the hit.
      java.lang.String getType()
      The type that the hit has.
      long getVersion()
      The version of the match or -1 if the version wasn't requested.
      XContentType getXContentType()
      The content type of the hit source.
    • Method Detail

      • getIndex

        java.lang.String getIndex()
        The index in which the hit is stored.
      • getType

        java.lang.String getType()
        The type that the hit has.
      • getId

        java.lang.String getId()
        The document id of the hit.
      • getVersion

        long getVersion()
        The version of the match or -1 if the version wasn't requested. The -1 keeps it inline with Elasticsearch's internal APIs.
      • getSource

        @Nullable
        BytesReference getSource()
        The source of the hit. Returns null if the source didn't come back from the search, usually because it source wasn't stored at all.
      • getXContentType

        @Nullable
        XContentType getXContentType()
        The content type of the hit source. Returns null if the source didn't come back from the search.
      • getParent

        @Nullable
        java.lang.String getParent()
        The document id of the parent of the hit if there is a parent or null if there isn't.
      • getRouting

        @Nullable
        java.lang.String getRouting()
        The routing on the hit if there is any or null if there isn't.