Module org.elasticsearch.server

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

Class CommonStatsFlags

java.lang.Object

org.elasticsearch.action.admin.indices.stats.CommonStatsFlags

All Implemented Interfaces:

Cloneable, Writeable

public class CommonStatsFlags
extends Object
implements Writeable, Cloneable

Contains flags that can be used to regulate the presence and calculation of different stat fields in CommonStats. The SHARD_LEVEL flags are for stat fields that can be calculated at the shard level and then may be later aggregated at the index level along with index-level flag stat fields (e.g., Mappings).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommonStatsFlags.Flag

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final CommonStatsFlags	ALL
static final CommonStatsFlags	NONE
static final CommonStatsFlags	SHARD_LEVEL

Constructor Summary

Constructors

Constructor	Description
CommonStatsFlags(CommonStatsFlags.Flag... flags)
CommonStatsFlags(StreamInput in)

Method Summary

Modifier and Type	Method	Description
CommonStatsFlags	all()	Sets all flags to return all stats.
boolean	anySet()
CommonStatsFlags	clear()	Clears all stats.
CommonStatsFlags	clone()
String[]	completionDataFields()
CommonStatsFlags	completionDataFields(String... completionDataFields)
String[]	fieldDataFields()
CommonStatsFlags	fieldDataFields(String... fieldDataFields)	Sets specific search group stats to retrieve the stats for.
CommonStatsFlags.Flag[]	getFlags()
String[]	groups()
CommonStatsFlags	groups(String... groups)	Sets specific search group stats to retrieve the stats for.
boolean	includeSegmentFileSizes()
CommonStatsFlags	includeSegmentFileSizes(boolean includeSegmentFileSizes)
boolean	includeUnloadedSegments()
CommonStatsFlags	includeUnloadedSegments(boolean includeUnloadedSegments)
boolean	isSet(CommonStatsFlags.Flag flag)
CommonStatsFlags	set(CommonStatsFlags.Flag flag, boolean add)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Details

ALL

public static final CommonStatsFlags ALL

SHARD_LEVEL

public static final CommonStatsFlags SHARD_LEVEL

NONE

public static final CommonStatsFlags NONE

Constructor Details

CommonStatsFlags

public CommonStatsFlags(CommonStatsFlags.Flag... flags)

Parameters:

flags - flags to set. If no flags are supplied, default flags will be set.

CommonStatsFlags

public CommonStatsFlags(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

Throws:

IOException

all

public CommonStatsFlags all()

Sets all flags to return all stats.

clear

public CommonStatsFlags clear()

Clears all stats.

anySet

public boolean anySet()

getFlags

public CommonStatsFlags.Flag[] getFlags()

groups

public CommonStatsFlags groups(String... groups)

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

groups

public String[] groups()

fieldDataFields

public CommonStatsFlags fieldDataFields(String... fieldDataFields)

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

fieldDataFields

public String[] fieldDataFields()

completionDataFields

public CommonStatsFlags completionDataFields(String... completionDataFields)

completionDataFields

public String[] completionDataFields()

includeSegmentFileSizes

public CommonStatsFlags includeSegmentFileSizes(boolean includeSegmentFileSizes)

includeUnloadedSegments

public CommonStatsFlags includeUnloadedSegments(boolean includeUnloadedSegments)

includeUnloadedSegments

public boolean includeUnloadedSegments()

includeSegmentFileSizes

public boolean includeSegmentFileSizes()

isSet

public boolean isSet(CommonStatsFlags.Flag flag)

set

public CommonStatsFlags set(CommonStatsFlags.Flag flag,
 boolean add)

clone

public CommonStatsFlags clone()

Overrides:

clone in class Object