Package org.opensearch.index.reindex

Class ScrollableHitSource.BasicHit

java.lang.Object

org.opensearch.index.reindex.ScrollableHitSource.BasicHit

All Implemented Interfaces:

ScrollableHitSource.Hit

Enclosing class:

ScrollableHitSource

public static class ScrollableHitSource.BasicHit
extends Object
implements ScrollableHitSource.Hit

An implementation of ScrollableHitSource.Hit that uses getters and setters.

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
BasicHit(String index, String id, long version)

Method Summary

Modifier and Type	Method	Description
String	getId()	The document id of the hit.
String	getIndex()	The index in which the hit is stored.
org.opensearch.core.xcontent.MediaType	getMediaType()	The content type of the hit source.
long	getPrimaryTerm()	The primary term of the match or SequenceNumbers.UNASSIGNED_PRIMARY_TERM if sequence numbers weren't requested.
String	getRouting()	The routing on the hit if there is any or null if there isn't.
long	getSeqNo()	The sequence number of the match or SequenceNumbers.UNASSIGNED_SEQ_NO if sequence numbers weren't requested.
org.opensearch.core.common.bytes.BytesReference	getSource()	The source of the hit.
long	getVersion()	The version of the match or -1 if the version wasn't requested.
void	setPrimaryTerm(long primaryTerm)
ScrollableHitSource.BasicHit	setRouting(String routing)
void	setSeqNo(long seqNo)
ScrollableHitSource.BasicHit	setSource(org.opensearch.core.common.bytes.BytesReference source, org.opensearch.core.xcontent.MediaType mediaType)

Methods inherited from class java.lang.Object

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

Constructor Details

BasicHit

public BasicHit(String index,
 String id,
 long version)

Method Details

getIndex

public String getIndex()

Description copied from interface: ScrollableHitSource.Hit

The index in which the hit is stored.

Specified by:

getIndex in interface ScrollableHitSource.Hit

getId

public String getId()

Description copied from interface: ScrollableHitSource.Hit

The document id of the hit.

Specified by:

getId in interface ScrollableHitSource.Hit

getVersion

public long getVersion()

Description copied from interface: ScrollableHitSource.Hit

The version of the match or -1 if the version wasn't requested. The -1 keeps it inline with OpenSearch's internal APIs.

Specified by:

getVersion in interface ScrollableHitSource.Hit

getSeqNo

public long getSeqNo()

Description copied from interface: ScrollableHitSource.Hit

The sequence number of the match or SequenceNumbers.UNASSIGNED_SEQ_NO if sequence numbers weren't requested.

Specified by:

getSeqNo in interface ScrollableHitSource.Hit

getPrimaryTerm

public long getPrimaryTerm()

Description copied from interface: ScrollableHitSource.Hit

The primary term of the match or SequenceNumbers.UNASSIGNED_PRIMARY_TERM if sequence numbers weren't requested.

Specified by:

getPrimaryTerm in interface ScrollableHitSource.Hit

getSource

public org.opensearch.core.common.bytes.BytesReference getSource()

Description copied from interface: ScrollableHitSource.Hit

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.

Specified by:

getSource in interface ScrollableHitSource.Hit

getMediaType

public org.opensearch.core.xcontent.MediaType getMediaType()

Description copied from interface: ScrollableHitSource.Hit

The content type of the hit source. Returns null if the source didn't come back from the search.

Specified by:

getMediaType in interface ScrollableHitSource.Hit

setSource

public ScrollableHitSource.BasicHit setSource(org.opensearch.core.common.bytes.BytesReference source,
 org.opensearch.core.xcontent.MediaType mediaType)

getRouting

public String getRouting()

Description copied from interface: ScrollableHitSource.Hit

The routing on the hit if there is any or null if there isn't.

Specified by:

getRouting in interface ScrollableHitSource.Hit

setRouting

public ScrollableHitSource.BasicHit setRouting(String routing)

setSeqNo

public void setSeqNo(long seqNo)

setPrimaryTerm

public void setPrimaryTerm(long primaryTerm)