Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.async

Class GetAsyncStatusRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.xpack.core.async.GetAsyncStatusRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public class GetAsyncStatusRequest
extends UntypedActionRequest

A request class to get a status update of the async search request

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
GetAsyncStatusRequest(String id)	Creates a new request
GetAsyncStatusRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getId()	Returns the id of the async search.
TimeValue	getKeepAlive()
int	hashCode()
GetAsyncStatusRequest	setKeepAlive(TimeValue timeValue)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Constructor Details

GetAsyncStatusRequest

public GetAsyncStatusRequest(String id)

Creates a new request

Parameters:

id - The id of the search progress request.

GetAsyncStatusRequest

public GetAsyncStatusRequest(StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

getId

public String getId()

Returns the id of the async search.

setKeepAlive

public GetAsyncStatusRequest setKeepAlive(TimeValue timeValue)

Parameters:

timeValue - Extends the amount of time after which the result will expire (defaults to no extension).

Returns:

this object

getKeepAlive

public TimeValue getKeepAlive()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object