org.elasticsearch.action.support.single.shard

クラス SingleShardRequest<T extends SingleShardRequest>

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.single.shard.SingleShardRequest<T>

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

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

直系の既知のサブクラス:

AnalyzeRequest, ExplainRequest, GetFieldMappingsIndexRequest, GetRequest, MultiGetShardRequest, MultiTermVectorsShardRequest, TermVectorsRequest, TransportShardMultiPercolateAction.Request

public abstract class SingleShardRequest<T extends SingleShardRequest>
extends ActionRequest<T>
implements IndicesRequest

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

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

TransportRequest.Empty

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

IndicesRequest.Replaceable

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected String	index The concrete index name Whether index property is optional depends on the concrete implementation.
static IndicesOptions	INDICES_OPTIONS

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

headers

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

コンストラクタ

修飾子	コンストラクタと説明
	SingleShardRequest()
protected	SingleShardRequest(ActionRequest request)
protected	SingleShardRequest(ActionRequest request, String index)
protected	SingleShardRequest(String index)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	index()
T	index(String index) Sets the index.
String[]	indices() Returns the array of indices that the action relates to
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
boolean	operationThreaded() Controls if the operation will be executed on a separate thread when executed locally.
T	operationThreaded(boolean threadedOperation) Controls if the operation will be executed on a separate thread when executed locally.
void	readFrom(StreamInput in)
protected ActionRequestValidationException	validateNonNullIndex()
void	writeTo(StreamOutput out)

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

validate

クラスから継承されたメソッド 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

フィールドの詳細

INDICES_OPTIONS

public static final IndicesOptions INDICES_OPTIONS

index

@Nullable
protected String index

The concrete index name Whether index property is optional depends on the concrete implementation. If index property is required the concrete implementation should use validateNonNullIndex() to check if the index property has been set

コンストラクタの詳細

SingleShardRequest

public SingleShardRequest()

SingleShardRequest

protected SingleShardRequest(String index)

SingleShardRequest

protected SingleShardRequest(ActionRequest request)

SingleShardRequest

protected SingleShardRequest(ActionRequest request,
                             String index)

メソッドの詳細

validateNonNullIndex

protected ActionRequestValidationException validateNonNullIndex()

戻り値:

a validation exception if the index property hasn't been set

index

@Nullable
public String index()

戻り値:

The concrete index this request is targeted for or null if index is optional. Whether index property is optional depends on the concrete implementation. If index property is required the concrete implementation should use validateNonNullIndex() to check if the index property has been set

index

public final T index(String index)

Sets the index.

indices

public String[] indices()

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

Returns the array of indices that the action relates to

定義:

indices インタフェース内 IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

インタフェースからコピーされた説明: 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.

定義:

indicesOptions インタフェース内 IndicesRequest

operationThreaded

public boolean operationThreaded()

Controls if the operation will be executed on a separate thread when executed locally.

operationThreaded

public final T operationThreaded(boolean threadedOperation)

Controls if the operation will be executed on a separate thread when executed locally.

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

オーバーライド:

readFrom クラス内 ActionRequest<T extends SingleShardRequest>

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

オーバーライド:

writeTo クラス内 ActionRequest<T extends SingleShardRequest>

例外:

IOException