Package org.elasticsearch.action.admin.indices.stats

Class FieldUsageStatsRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.broadcast.BroadcastRequest<FieldUsageStatsRequest>

org.elasticsearch.action.admin.indices.stats.FieldUsageStatsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest

public class FieldUsageStatsRequest
extends BroadcastRequest<FieldUsageStatsRequest>

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

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

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

Field Summary

Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest

DEFAULT_INDICES_OPTIONS, indices

Constructor Summary

Constructors

Constructor	Description
FieldUsageStatsRequest(String... indices)
FieldUsageStatsRequest(String[] indices, IndicesOptions indicesOptions)
FieldUsageStatsRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
String[]	fields()
FieldUsageStatsRequest	fields(String... fields)
String	getDescription()	Returns optional description of the request to be displayed by the task manager
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest

includeDataStreams, indices, indices, indicesOptions, indicesOptions, timeout, timeout, validate

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Constructor Details

FieldUsageStatsRequest

public FieldUsageStatsRequest(String... indices)

FieldUsageStatsRequest

public FieldUsageStatsRequest(String[] indices,
 IndicesOptions indicesOptions)

FieldUsageStatsRequest

public FieldUsageStatsRequest(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BroadcastRequest<FieldUsageStatsRequest>

Throws:

IOException

fields

public FieldUsageStatsRequest fields(String... fields)

fields

public String[] fields()

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager