Package org.elasticsearch.action.get
Class MultiGetRequest.Item
java.lang.Object
org.elasticsearch.action.get.MultiGetRequest.Item
- All Implemented Interfaces:
IndicesRequest
,Writeable
,ToXContent
,ToXContentObject
- Enclosing class:
- MultiGetRequest
public static class MultiGetRequest.Item
extends Object
implements Writeable, IndicesRequest, ToXContentObject
A single get item.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable
Nested classes/interfaces inherited from interface org.elasticsearch.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.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
fetchSourceContext
(FetchSourceContext fetchSourceContext) Allows setting theFetchSourceContext
for this request, controlling if and how _source should be returned.int
hashCode()
id()
index()
String[]
indices()
Returns the array of indices that the action relates toReturns the indices options used to resolve indices.routing()
The routing associated with this document.String[]
storedFields
(String... fields) toString()
toXContent
(XContentBuilder builder, ToXContent.Params params) type()
long
version()
version
(long version) versionType
(VersionType versionType) void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.action.IndicesRequest
includeDataStreams
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
Item
public Item() -
Item
- Throws:
IOException
-
Item
Deprecated.Types are in the process of being removed, useinstead
.Constructs a single get item.- Parameters:
index
- The index nametype
- The type (can be null)id
- The id
-
Item
-
-
Method Details
-
index
-
indices
Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
indicesOptions
Description copied from interface:IndicesRequest
Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.- Specified by:
indicesOptions
in interfaceIndicesRequest
-
index
-
type
-
id
-
routing
The routing associated with this document. -
routing
-
storedFields
-
storedFields
-
version
public long version() -
version
-
versionType
-
versionType
-
fetchSourceContext
-
fetchSourceContext
Allows setting theFetchSourceContext
for this request, controlling if and how _source should be returned. -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
toString
-
instead
.