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 java.lang.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
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
FetchSourceContext
fetchSourceContext()
MultiGetRequest.Item
fetchSourceContext(FetchSourceContext fetchSourceContext)
Allows setting theFetchSourceContext
for this request, controlling if and how _source should be returned.int
hashCode()
java.lang.String
id()
java.lang.String
index()
MultiGetRequest.Item
index(java.lang.String index)
java.lang.String[]
indices()
Returns the array of indices that the action relates toIndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.java.lang.String
routing()
MultiGetRequest.Item
routing(java.lang.String routing)
The routing associated with this document.java.lang.String[]
storedFields()
MultiGetRequest.Item
storedFields(java.lang.String... fields)
java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String
type()
long
version()
MultiGetRequest.Item
version(long version)
VersionType
versionType()
MultiGetRequest.Item
versionType(VersionType versionType)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Constructor Details
-
Item
public Item() -
Item
- Throws:
java.io.IOException
-
Item
@Deprecated public Item(java.lang.String index, @Nullable java.lang.String type, java.lang.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
-
Item
public Item(java.lang.String index, java.lang.String id)
-
-
Method Details
-
index
public java.lang.String index() -
indices
public java.lang.String[] 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
public java.lang.String type() -
id
public java.lang.String id() -
routing
The routing associated with this document. -
routing
public java.lang.String routing() -
storedFields
-
storedFields
public java.lang.String[] 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. -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-