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

Class IndicesStatsRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

org.elasticsearch.action.admin.indices.stats.IndicesStatsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class IndicesStatsRequest
extends BroadcastRequest<IndicesStatsRequest>

A request to get indices level stats. Allow to enable different stats to be returned.

By default, all statistics are enabled.

All the stats to be returned can be cleared using clear(), at which point, specific stats can be enabled.

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

indices

Constructor Summary

Constructors

Constructor	Description
IndicesStatsRequest()
IndicesStatsRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
IndicesStatsRequest	all()	Sets all flags to return all stats.
IndicesStatsRequest	clear()	Clears all stats.
boolean	completion()
IndicesStatsRequest	completion(boolean completion)
String[]	completionFields()
IndicesStatsRequest	completionFields(String... completionDataFields)
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.
boolean	docs()
IndicesStatsRequest	docs(boolean docs)
boolean	fieldData()
IndicesStatsRequest	fieldData(boolean fieldData)
String[]	fieldDataFields()
IndicesStatsRequest	fieldDataFields(String... fieldDataFields)
CommonStatsFlags	flags()	Returns the underlying stats flags.
IndicesStatsRequest	flags(CommonStatsFlags flags)	Sets the underlying stats flags.
boolean	flush()
IndicesStatsRequest	flush(boolean flush)
boolean	get()
IndicesStatsRequest	get(boolean get)
String[]	groups()
IndicesStatsRequest	groups(String... groups)	Sets specific search group stats to retrieve the stats for.
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
boolean	includeSegmentFileSizes()
IndicesStatsRequest	includeSegmentFileSizes(boolean includeSegmentFileSizes)
IndicesStatsRequest	includeUnloadedSegments(boolean includeUnloadedSegments)
boolean	indexing()
IndicesStatsRequest	indexing(boolean indexing)
boolean	merge()
IndicesStatsRequest	merge(boolean merge)
boolean	queryCache()
IndicesStatsRequest	queryCache(boolean queryCache)
boolean	recovery()
IndicesStatsRequest	recovery(boolean recovery)
boolean	refresh()
IndicesStatsRequest	refresh(boolean refresh)
boolean	requestCache()
IndicesStatsRequest	requestCache(boolean requestCache)
boolean	search()
IndicesStatsRequest	search(boolean search)
boolean	segments()
IndicesStatsRequest	segments(boolean segments)
boolean	store()
IndicesStatsRequest	store(boolean store)
boolean	translog()
IndicesStatsRequest	translog(boolean translog)
String[]	types()	Document types to return stats for.
IndicesStatsRequest	types(String... types)	Document types to return stats for.
boolean	warmer()
IndicesStatsRequest	warmer(boolean warmer)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

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

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

getDescription, setParentTask

Constructor Details

IndicesStatsRequest

public IndicesStatsRequest()

IndicesStatsRequest

public IndicesStatsRequest(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

all

public IndicesStatsRequest all()

Sets all flags to return all stats.

clear

public IndicesStatsRequest clear()

Clears all stats.

flags

public CommonStatsFlags flags()

Returns the underlying stats flags.

flags

public IndicesStatsRequest flags(CommonStatsFlags flags)

Sets the underlying stats flags.

types

public IndicesStatsRequest types(String... types)

Document types to return stats for. Mainly affects indexing(boolean) when enabled, returning specific indexing stats for those types.

types

public String[] types()

Document types to return stats for. Mainly affects indexing(boolean) when enabled, returning specific indexing stats for those types.

groups

public IndicesStatsRequest groups(String... groups)

Sets specific search group stats to retrieve the stats for. Mainly affects search when enabled.

groups

public String[] groups()

docs

public IndicesStatsRequest docs(boolean docs)

docs

public boolean docs()

store

public IndicesStatsRequest store(boolean store)

store

public boolean store()

indexing

public IndicesStatsRequest indexing(boolean indexing)

indexing

public boolean indexing()

get

public IndicesStatsRequest get(boolean get)

get

public boolean get()

search

public IndicesStatsRequest search(boolean search)

search

public boolean search()

merge

public IndicesStatsRequest merge(boolean merge)

merge

public boolean merge()

refresh

public IndicesStatsRequest refresh(boolean refresh)

refresh

public boolean refresh()

flush

public IndicesStatsRequest flush(boolean flush)

flush

public boolean flush()

warmer

public IndicesStatsRequest warmer(boolean warmer)

warmer

public boolean warmer()

queryCache

public IndicesStatsRequest queryCache(boolean queryCache)

queryCache

public boolean queryCache()

fieldData

public IndicesStatsRequest fieldData(boolean fieldData)

fieldData

public boolean fieldData()

segments

public IndicesStatsRequest segments(boolean segments)

segments

public boolean segments()

fieldDataFields

public IndicesStatsRequest fieldDataFields(String... fieldDataFields)

fieldDataFields

public String[] fieldDataFields()

completion

public IndicesStatsRequest completion(boolean completion)

completion

public boolean completion()

completionFields

public IndicesStatsRequest completionFields(String... completionDataFields)

completionFields

public String[] completionFields()

translog

public IndicesStatsRequest translog(boolean translog)

translog

public boolean translog()

requestCache

public IndicesStatsRequest requestCache(boolean requestCache)

requestCache

public boolean requestCache()

recovery

public IndicesStatsRequest recovery(boolean recovery)

recovery

public boolean recovery()

includeSegmentFileSizes

public boolean includeSegmentFileSizes()

includeSegmentFileSizes

public IndicesStatsRequest includeSegmentFileSizes(boolean includeSegmentFileSizes)

includeUnloadedSegments

public IndicesStatsRequest includeUnloadedSegments(boolean includeUnloadedSegments)

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<IndicesStatsRequest>

Throws:

IOException

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

Overrides:

includeDataStreams in class BroadcastRequest<IndicesStatsRequest>

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.