org.elasticsearch.action.admin.indices.stats

Class CommonStatsFlags

java.lang.Object

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

All Implemented Interfaces:

Cloneable, Streamable

public class CommonStatsFlags
extends Object
implements Streamable, Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonStatsFlags.Flag

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CommonStatsFlags(CommonStatsFlags.Flag... flags)

Method Summary

Methods

Modifier and Type	Method and 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	isSet(CommonStatsFlags.Flag flag)
static CommonStatsFlags	readCommonStatsFlags(StreamInput in)
void	readFrom(StreamInput in)
CommonStatsFlags	set(CommonStatsFlags.Flag flag, boolean add)
String[]	types() Document types to return stats for.
CommonStatsFlags	types(String... types) Document types to return stats for.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final CommonStatsFlags ALL

NONE

public static final CommonStatsFlags NONE

Constructor Detail

CommonStatsFlags

public CommonStatsFlags(CommonStatsFlags.Flag... flags)

Parameters:

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

Method Detail

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

types

public CommonStatsFlags types(String... types)

Document types to return stats for. Mainly affects CommonStatsFlags.Flag.Indexing when enabled, returning specific indexing stats for those types.

types

public String[] types()

Document types to return stats for. Mainly affects CommonStatsFlags.Flag.Indexing when enabled, returning specific indexing stats for those types.

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

isSet

public boolean isSet(CommonStatsFlags.Flag flag)

set

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

readCommonStatsFlags

public static CommonStatsFlags readCommonStatsFlags(StreamInput in)
                                             throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

clone

public CommonStatsFlags clone()

Overrides:

clone in class Object