org.elasticsearch.action.get

クラス MultiGetRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<MultiGetRequest>

org.elasticsearch.action.get.MultiGetRequest

すべての実装されたインタフェース:

Iterable<MultiGetRequest.Item>, CompositeIndicesRequest, RealtimeRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class MultiGetRequest
extends ActionRequest<MultiGetRequest>
implements Iterable<MultiGetRequest.Item>, CompositeIndicesRequest, RealtimeRequest

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	MultiGetRequest.Item A single get item.

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
boolean	ignoreErrorsOnGeneratedFields

クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder

headers

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MultiGetRequest()
MultiGetRequest(ActionRequest request) Creates a multi get request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request

メソッドのサマリー

修飾子とタイプ	メソッドと説明
MultiGetRequest	add(MultiGetRequest.Item item)
MultiGetRequest	add(String index, String type, String id)
MultiGetRequest	add(String defaultIndex, String defaultType, String[] defaultFields, FetchSourceContext defaultFetchSource, byte[] data, int from, int length)
MultiGetRequest	add(String defaultIndex, String defaultType, String[] defaultFields, FetchSourceContext defaultFetchSource, BytesReference data)
MultiGetRequest	add(String defaultIndex, String defaultType, String[] defaultFields, FetchSourceContext defaultFetchSource, BytesReference data, boolean allowExplicitIndex)
MultiGetRequest	add(String defaultIndex, String defaultType, String[] defaultFields, FetchSourceContext defaultFetchSource, String defaultRouting, BytesReference data, boolean allowExplicitIndex)
List<MultiGetRequest.Item>	getItems()
MultiGetRequest	ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields)
Iterator<MultiGetRequest.Item>	iterator()
static void	parseDocuments(XContentParser parser, List<MultiGetRequest.Item> items)
static void	parseDocuments(XContentParser parser, List<MultiGetRequest.Item> items, String defaultIndex, String defaultType, String[] defaultFields, FetchSourceContext defaultFetchSource, String defaultRouting, boolean allowExplicitIndex)
static void	parseIds(XContentParser parser, List<MultiGetRequest.Item> items)
static void	parseIds(XContentParser parser, List<MultiGetRequest.Item> items, String defaultIndex, String defaultType, String[] defaultFields, FetchSourceContext defaultFetchSource, String defaultRouting)
String	preference()
MultiGetRequest	preference(String preference) Sets the preference to execute the search.
void	readFrom(StreamInput in)
boolean	realtime()
MultiGetRequest	realtime(Boolean realtime)
boolean	refresh()
MultiGetRequest	refresh(boolean refresh)
List<? extends IndicesRequest>	subRequests() Returns the subrequests that a composite request is composed of
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

クラスから継承されたメソッド org.elasticsearch.transport.TransportRequest

createTask, getDescription

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド java.lang.Iterable

forEach, spliterator

フィールドの詳細

ignoreErrorsOnGeneratedFields

public boolean ignoreErrorsOnGeneratedFields

コンストラクタの詳細

MultiGetRequest

public MultiGetRequest()

MultiGetRequest

public MultiGetRequest(ActionRequest request)

Creates a multi get request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request

メソッドの詳細

getItems

public List<MultiGetRequest.Item> getItems()

add

public MultiGetRequest add(MultiGetRequest.Item item)

add

public MultiGetRequest add(String index,
                           @Nullable
                           String type,
                           String id)

validate

public ActionRequestValidationException validate()

定義:

validate クラス内 ActionRequest<MultiGetRequest>

subRequests

public List<? extends IndicesRequest> subRequests()

インタフェースからコピーされた説明: CompositeIndicesRequest

Returns the subrequests that a composite request is composed of

定義:

subRequests インタフェース内 CompositeIndicesRequest

preference

public MultiGetRequest preference(String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, or a custom value, which guarantees that the same order will be used across different requests.

preference

public String preference()

realtime

public boolean realtime()

realtime

public MultiGetRequest realtime(Boolean realtime)

定義:

realtime インタフェース内 RealtimeRequest

パラメータ:

realtime - Controls whether this request should be realtime by reading from the translog. If null is specified then whether the operation will be realtime depends on the api of the concrete request subclass.

refresh

public boolean refresh()

refresh

public MultiGetRequest refresh(boolean refresh)

ignoreErrorsOnGeneratedFields

public MultiGetRequest ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields)

add

public MultiGetRequest add(@Nullable
                           String defaultIndex,
                           @Nullable
                           String defaultType,
                           @Nullable
                           String[] defaultFields,
                           @Nullable
                           FetchSourceContext defaultFetchSource,
                           byte[] data,
                           int from,
                           int length)
                    throws Exception

例外:

Exception

add

public MultiGetRequest add(@Nullable
                           String defaultIndex,
                           @Nullable
                           String defaultType,
                           @Nullable
                           String[] defaultFields,
                           @Nullable
                           FetchSourceContext defaultFetchSource,
                           BytesReference data)
                    throws Exception

例外:

Exception

add

public MultiGetRequest add(@Nullable
                           String defaultIndex,
                           @Nullable
                           String defaultType,
                           @Nullable
                           String[] defaultFields,
                           @Nullable
                           FetchSourceContext defaultFetchSource,
                           BytesReference data,
                           boolean allowExplicitIndex)
                    throws Exception

例外:

Exception

add

public MultiGetRequest add(@Nullable
                           String defaultIndex,
                           @Nullable
                           String defaultType,
                           @Nullable
                           String[] defaultFields,
                           @Nullable
                           FetchSourceContext defaultFetchSource,
                           @Nullable
                           String defaultRouting,
                           BytesReference data,
                           boolean allowExplicitIndex)
                    throws Exception

例外:

Exception

parseDocuments

public static void parseDocuments(XContentParser parser,
                                  List<MultiGetRequest.Item> items,
                                  @Nullable
                                  String defaultIndex,
                                  @Nullable
                                  String defaultType,
                                  @Nullable
                                  String[] defaultFields,
                                  @Nullable
                                  FetchSourceContext defaultFetchSource,
                                  @Nullable
                                  String defaultRouting,
                                  boolean allowExplicitIndex)
                           throws IOException

例外:

IOException

parseDocuments

public static void parseDocuments(XContentParser parser,
                                  List<MultiGetRequest.Item> items)
                           throws IOException

例外:

IOException

parseIds

public static void parseIds(XContentParser parser,
                            List<MultiGetRequest.Item> items,
                            @Nullable
                            String defaultIndex,
                            @Nullable
                            String defaultType,
                            @Nullable
                            String[] defaultFields,
                            @Nullable
                            FetchSourceContext defaultFetchSource,
                            @Nullable
                            String defaultRouting)
                     throws IOException

例外:

IOException

parseIds

public static void parseIds(XContentParser parser,
                            List<MultiGetRequest.Item> items)
                     throws IOException

例外:

IOException

iterator

public Iterator<MultiGetRequest.Item> iterator()

定義:

iterator インタフェース内 Iterable<MultiGetRequest.Item>

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

オーバーライド:

readFrom クラス内 ActionRequest<MultiGetRequest>

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

オーバーライド:

writeTo クラス内 ActionRequest<MultiGetRequest>

例外:

IOException