Module org.elasticsearch.server
Class CommonStatsFlags
java.lang.Object
org.elasticsearch.action.admin.indices.stats.CommonStatsFlags
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 ClassesNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final CommonStatsFlagsstatic final CommonStatsFlagsstatic final CommonStatsFlags -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionall()Sets all flags to return all stats.booleananySet()clear()Clears all stats.clone()String[]completionDataFields(String... completionDataFields) String[]fieldDataFields(String... fieldDataFields) Sets specific search group stats to retrieve the stats for.getFlags()String[]groups()Sets specific search group stats to retrieve the stats for.booleanincludeSegmentFileSizes(boolean includeSegmentFileSizes) booleanincludeUnloadedSegments(boolean includeUnloadedSegments) booleanisSet(CommonStatsFlags.Flag flag) set(CommonStatsFlags.Flag flag, boolean add) voidwriteTo(StreamOutput out) Write this into the StreamOutput.
-
Field Details
-
ALL
-
SHARD_LEVEL
-
NONE
-
-
Constructor Details
-
CommonStatsFlags
- Parameters:
flags- flags to set. If no flags are supplied, default flags will be set.
-
CommonStatsFlags
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
all
Sets all flags to return all stats. -
clear
Clears all stats. -
anySet
public boolean anySet() -
getFlags
-
groups
Sets specific search group stats to retrieve the stats for. Mainly affects search when enabled. -
groups
-
fieldDataFields
Sets specific search group stats to retrieve the stats for. Mainly affects search when enabled. -
fieldDataFields
-
completionDataFields
-
completionDataFields
-
includeSegmentFileSizes
-
includeUnloadedSegments
-
includeUnloadedSegments
public boolean includeUnloadedSegments() -
includeSegmentFileSizes
public boolean includeSegmentFileSizes() -
isSet
-
set
-
clone
-