java.lang.Object

org.elasticsearch.search.SearchHit.NestedIdentity

All Implemented Interfaces:: Writeable, ToXContent, ToXContentFragment

public static final class SearchHit.NestedIdentity
extends java.lang.Object
implements Writeable, ToXContentFragment

Encapsulates the nested identity of a hit.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
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(XContentParser parser)`
`SearchHit.NestedIdentity`	`getChild()`	Returns the next child nested level if there is any, otherwise `null` is returned.
`Text`	`getField()`	Returns the nested field in the source this hit originates from
`int`	`getOffset()`	Returns the offset in the nested array of objects in the source this hit
`int`	`hashCode()`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

isFragment

Constructor Details
- NestedIdentity
  
  public NestedIdentity(java.lang.String field, int offset, SearchHit.NestedIdentity child)
Method Details
- getField
  
  public Text 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
  
  public SearchHit.NestedIdentity getChild()
  
  Returns the next child nested level if there is any, otherwise null is returned. In the case of mappings with multiple levels of nested object fields
- writeTo
  
  public void writeTo(StreamOutput out) throws java.io.IOException
  
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Throws:
  
  java.io.IOException
- toXContent
  
  public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
  
  Specified by:
  
  toXContent in interface ToXContent
  
  Throws:
  
  java.io.IOException
- fromXContent
  
  public static SearchHit.NestedIdentity fromXContent(XContentParser parser)
- equals
  
  public boolean equals(java.lang.Object obj)
  
  Overrides:
  
  equals in class java.lang.Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object

Class SearchHit.NestedIdentity