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.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
-
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Constructor Detail
-
Item
public Item()
-
Item
public Item(StreamInput in) throws IOException
- Throws:
IOException
-
Item
@Deprecated public Item(String index, @Nullable String type, String id)
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
-
-
Method Detail
-
index
public String index()
-
indices
public String[] indices()
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
indicesOptions
public IndicesOptions indicesOptions()
Description copied from interface:IndicesRequestReturns 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:
indicesOptionsin interfaceIndicesRequest
-
index
public MultiGetRequest.Item index(String index)
-
type
public String type()
-
id
public String id()
-
routing
public MultiGetRequest.Item routing(String routing)
The routing associated with this document.
-
routing
public String routing()
-
storedFields
public MultiGetRequest.Item storedFields(String... fields)
-
storedFields
public String[] storedFields()
-
version
public long version()
-
version
public MultiGetRequest.Item version(long version)
-
versionType
public VersionType versionType()
-
versionType
public MultiGetRequest.Item versionType(VersionType versionType)
-
fetchSourceContext
public FetchSourceContext fetchSourceContext()
-
fetchSourceContext
public MultiGetRequest.Item fetchSourceContext(FetchSourceContext fetchSourceContext)
Allows setting theFetchSourceContextfor this request, controlling if and how _source should be returned.
-
writeTo
public void writeTo(StreamOutput out) throws IOException
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
- Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
-