org.elasticsearch.action.bulk.byscroll

Class ScrollableHitSource.BasicHit

java.lang.Object

org.elasticsearch.action.bulk.byscroll.ScrollableHitSource.BasicHit

All Implemented Interfaces:

ScrollableHitSource.Hit

Enclosing class:

ScrollableHitSource

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

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

Constructor Summary

Constructors

Constructor and Description
BasicHit(java.lang.String index, java.lang.String type, java.lang.String id, long version)

Method Summary

Modifier and Type	Method and 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.Long	getTimestamp() The _timestamp on the hit if one was stored with the hit or null if one wasn't.
java.lang.Long	getTTL() The _ttl on the hit if one was set on it or null one wasn't.
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.
ScrollableHitSource.BasicHit	setParent(java.lang.String parent)
ScrollableHitSource.BasicHit	setRouting(java.lang.String routing)
ScrollableHitSource.BasicHit	setSource(BytesReference source, XContentType xContentType)
ScrollableHitSource.BasicHit	setTimestamp(java.lang.Long timestamp)
ScrollableHitSource.BasicHit	setTTL(java.lang.Long ttl)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHit

public BasicHit(java.lang.String index,
                java.lang.String type,
                java.lang.String id,
                long version)

Method Detail

getIndex

public java.lang.String getIndex()

Description copied from interface: ScrollableHitSource.Hit

The index in which the hit is stored.

Specified by:

getIndex in interface ScrollableHitSource.Hit

getType

public java.lang.String getType()

Description copied from interface: ScrollableHitSource.Hit

The type that the hit has.

Specified by:

getType in interface ScrollableHitSource.Hit

getId

public java.lang.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 Elasticsearch's internal APIs.

Specified by:

getVersion in interface ScrollableHitSource.Hit

getSource

public 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

getXContentType

public XContentType getXContentType()

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:

getXContentType in interface ScrollableHitSource.Hit

setSource

public ScrollableHitSource.BasicHit setSource(BytesReference source,
                                              XContentType xContentType)

getParent

public java.lang.String getParent()

Description copied from interface: ScrollableHitSource.Hit

The document id of the parent of the hit if there is a parent or null if there isn't.

Specified by:

getParent in interface ScrollableHitSource.Hit

setParent

public ScrollableHitSource.BasicHit setParent(java.lang.String parent)

getRouting

public java.lang.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(java.lang.String routing)

getTimestamp

public java.lang.Long getTimestamp()

Description copied from interface: ScrollableHitSource.Hit

The _timestamp on the hit if one was stored with the hit or null if one wasn't.

Specified by:

getTimestamp in interface ScrollableHitSource.Hit

setTimestamp

public ScrollableHitSource.BasicHit setTimestamp(java.lang.Long timestamp)

getTTL

public java.lang.Long getTTL()

Description copied from interface: ScrollableHitSource.Hit

The _ttl on the hit if one was set on it or null one wasn't.

Specified by:

getTTL in interface ScrollableHitSource.Hit

setTTL

public ScrollableHitSource.BasicHit setTTL(java.lang.Long ttl)