org.elasticsearch.action.indexedscripts.get

クラス GetIndexedScriptRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<GetIndexedScriptRequest>

org.elasticsearch.action.indexedscripts.get.GetIndexedScriptRequest

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

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class GetIndexedScriptRequest
extends ActionRequest<GetIndexedScriptRequest>
implements IndicesRequest

A request to get an indexed script (its source) based on its language (optional) and id. The operation requires the scriptLang(String) and id(String) to be set.

関連項目:

GetIndexedScriptResponse

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

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

TransportRequest.Empty

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

IndicesRequest.Replaceable

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected String	id
protected String	scriptLang

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

headers

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

コンストラクタ

コンストラクタと説明
GetIndexedScriptRequest() Constructs a new get request against the script index.
GetIndexedScriptRequest(String scriptLang, String id) Constructs a new get request against the script index with the type and id.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	id()
GetIndexedScriptRequest	id(String id) Sets the id of the script to fetch.
String[]	indices() Returns the array of indices that the action relates to
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
void	readFrom(StreamInput in)
String	scriptLang()
GetIndexedScriptRequest	scriptLang(String type) Sets the language of the script to fetch.
String	toString()
ActionRequestValidationException	validate()
long	version() Sets the version, which will cause the get operation to only be performed if a matching version exists and no changes happened on the doc since then.
GetIndexedScriptRequest	version(long version)
VersionType	versionType()
GetIndexedScriptRequest	versionType(VersionType versionType) Sets the versioning type.
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, wait, wait, wait

フィールドの詳細

scriptLang

protected String scriptLang

id

protected String id

コンストラクタの詳細

GetIndexedScriptRequest

public GetIndexedScriptRequest()

Constructs a new get request against the script index. The scriptLang(String) and id(String) must be set.

GetIndexedScriptRequest

public GetIndexedScriptRequest(String scriptLang,
                               String id)

Constructs a new get request against the script index with the type and id.

パラメータ:

scriptLang - The language of the script

id - The id of the script

メソッドの詳細

validate

public ActionRequestValidationException validate()

定義:

validate クラス内 ActionRequest<GetIndexedScriptRequest>

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

scriptLang

public GetIndexedScriptRequest scriptLang(@Nullable
                                          String type)

Sets the language of the script to fetch.

id

public GetIndexedScriptRequest id(String id)

Sets the id of the script to fetch.

scriptLang

public String scriptLang()

id

public String id()

version

public long version()

Sets the version, which will cause the get operation to only be performed if a matching version exists and no changes happened on the doc since then.

version

public GetIndexedScriptRequest version(long version)

versionType

public GetIndexedScriptRequest versionType(VersionType versionType)

Sets the versioning type. Defaults to VersionType.INTERNAL.

versionType

public VersionType versionType()

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

オーバーライド:

readFrom クラス内 ActionRequest<GetIndexedScriptRequest>

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

オーバーライド:

writeTo クラス内 ActionRequest<GetIndexedScriptRequest>

例外:

IOException

toString

public String toString()

オーバーライド:

toString クラス内 Object