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

java.lang.Object
  org.elasticsearch.action.support.broadcast.BroadcastOperationRequest
      org.elasticsearch.action.admin.indices.stats.IndicesStatsRequest

All Implemented Interfaces:

ActionRequest, Streamable

public class IndicesStatsRequest
extends BroadcastOperationRequest

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

By default, the docs(boolean), store(boolean), indexing(boolean) are enabled. Other stats can be enabled as well.

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

Field Summary

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

indices

Constructor Summary

IndicesStatsRequest()

Method Summary

IndicesStatsRequest	all() Sets all flags to return all stats.
IndicesStatsRequest	clear() Clears all stats.
boolean	docs()
IndicesStatsRequest	docs(boolean docs)
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	indexing()
IndicesStatsRequest	indexing(boolean indexing)
IndicesStatsRequest	indices(String... indices)
boolean	merge()
IndicesStatsRequest	merge(boolean merge)
void	readFrom(StreamInput in)
boolean	refresh()
IndicesStatsRequest	refresh(boolean refresh)
boolean	search()
IndicesStatsRequest	search(boolean search)
boolean	store()
IndicesStatsRequest	store(boolean store)
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)

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

beforeLocalFork, beforeStart, ignoreIndices, ignoreIndices, indices, listenerThreaded, listenerThreaded, operationThreading, operationThreading, operationThreading, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

IndicesStatsRequest

public IndicesStatsRequest()

Method Detail

indices

public IndicesStatsRequest indices(String... indices)

Overrides:

indices in class BroadcastOperationRequest

all

public IndicesStatsRequest all()

Sets all flags to return all stats.

clear

public IndicesStatsRequest clear()

Clears all stats.

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()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastOperationRequest

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastOperationRequest

Throws:

IOException