org.elasticsearch.action.indexedscripts.get

Class GetIndexedScriptRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<GetIndexedScriptRequest>

org.elasticsearch.action.indexedscripts.get.GetIndexedScriptRequest

All Implemented Interfaces:

IndicesRequest, 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.

See Also:

GetIndexedScriptResponse

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id
protected java.lang.String	scriptLang

Constructor Summary

Constructors

Constructor and Description
GetIndexedScriptRequest() Constructs a new get request against the script index.
GetIndexedScriptRequest(java.lang.String scriptLang, java.lang.String id) Constructs a new get request against the script index with the type and id.

Method Summary

Modifier and Type	Method and Description
java.lang.String	id()
GetIndexedScriptRequest	id(java.lang.String id) Sets the id of the script to fetch.
java.lang.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) Set this object's fields from a StreamInput.
java.lang.String	scriptLang()
GetIndexedScriptRequest	scriptLang(java.lang.String type) Sets the language of the script to fetch.
java.lang.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) Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Field Detail

scriptLang

protected java.lang.String scriptLang

id

protected java.lang.String id

Constructor Detail

GetIndexedScriptRequest

public GetIndexedScriptRequest()

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

GetIndexedScriptRequest

public GetIndexedScriptRequest(java.lang.String scriptLang,
                               java.lang.String id)

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

Parameters:

scriptLang - The language of the script

id - The id of the script

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<GetIndexedScriptRequest>

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 interface IndicesRequest

indicesOptions

public IndicesOptions 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 interface IndicesRequest

scriptLang

public GetIndexedScriptRequest scriptLang(@Nullable
                                          java.lang.String type)

Sets the language of the script to fetch.

id

public GetIndexedScriptRequest id(java.lang.String id)

Sets the id of the script to fetch.

scriptLang

public java.lang.String scriptLang()

id

public java.lang.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 java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<GetIndexedScriptRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<GetIndexedScriptRequest>

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object