org.elasticsearch.action.indexedscripts.delete

Class DeleteIndexedScriptRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<DeleteIndexedScriptRequest>

org.elasticsearch.action.indexedscripts.delete.DeleteIndexedScriptRequest

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class DeleteIndexedScriptRequest
extends ActionRequest<DeleteIndexedScriptRequest>
implements IndicesRequest

A request to delete a script from the script index based on its scriptLang and id. Best created using

The operation requires the , scriptLang(String) and id(String) to be set.

See Also:

DeleteIndexedScriptResponse, Client.deleteIndexedScript(DeleteIndexedScriptRequest)

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 inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
DeleteIndexedScriptRequest()
DeleteIndexedScriptRequest(String scriptLang, String id) Constructs a new delete request against the specified index with the scriptLang and id.

Method Summary

Methods

Modifier and Type	Method and Description
String	id() The id of the document to delete.
DeleteIndexedScriptRequest	id(String id) Sets the id of the document to delete.
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() The scriptLang of the document to delete.
DeleteIndexedScriptRequest	scriptLang(String type) Sets the scriptLang of the document to delete.
String	toString()
ActionRequestValidationException	validate()
long	version()
DeleteIndexedScriptRequest	version(long version) Sets the version, which will cause the delete operation to only be performed if a matching version exists and no changes happened on the doc since then.
VersionType	versionType()
DeleteIndexedScriptRequest	versionType(VersionType versionType)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteIndexedScriptRequest

public DeleteIndexedScriptRequest()

DeleteIndexedScriptRequest

public DeleteIndexedScriptRequest(String scriptLang,
                          String id)

Constructs a new delete request against the specified index with the scriptLang and id.

Parameters:

scriptLang - The scriptLang of the document

id - The id of the document

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<DeleteIndexedScriptRequest>

indices

public 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 String scriptLang()

The scriptLang of the document to delete.

scriptLang

public DeleteIndexedScriptRequest scriptLang(String type)

Sets the scriptLang of the document to delete.

id

public String id()

The id of the document to delete.

id

public DeleteIndexedScriptRequest id(String id)

Sets the id of the document to delete.

version

public DeleteIndexedScriptRequest version(long version)

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

version

public long version()

versionType

public DeleteIndexedScriptRequest versionType(VersionType versionType)

versionType

public VersionType versionType()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<DeleteIndexedScriptRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<DeleteIndexedScriptRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object