Package org.opensearch.search
Class SearchHit.NestedIdentity
java.lang.Object
org.opensearch.search.SearchHit.NestedIdentity
- All Implemented Interfaces:
Writeable
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentFragment
- Enclosing class:
- SearchHit
public static final class SearchHit.NestedIdentity extends java.lang.Object implements Writeable, org.opensearch.common.xcontent.ToXContentFragment
Encapsulates the nested identity of a hit.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
-
Constructor Summary
Constructors Constructor Description NestedIdentity(java.lang.String field, int offset, SearchHit.NestedIdentity child)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static SearchHit.NestedIdentity
fromXContent(org.opensearch.common.xcontent.XContentParser parser)
SearchHit.NestedIdentity
getChild()
Returns the next child nested level if there is any, otherwisenull
is returned.Text
getField()
Returns the nested field in the source this hit originates fromint
getOffset()
Returns the offset in the nested array of objects in the source this hitint
hashCode()
org.opensearch.common.xcontent.XContentBuilder
toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Constructor Details
-
Method Details
-
getField
Returns the nested field in the source this hit originates from -
getOffset
public int getOffset()Returns the offset in the nested array of objects in the source this hit -
getChild
Returns the next child nested level if there is any, otherwisenull
is returned. In the case of mappings with multiple levels of nested object fields -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.opensearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
fromXContent
public static SearchHit.NestedIdentity fromXContent(org.opensearch.common.xcontent.XContentParser parser) -
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-