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
,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
-
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)
java.lang.String[]
completionFields()
IndicesStatsRequest
completionFields(java.lang.String... completionDataFields)
boolean
docs()
IndicesStatsRequest
docs(boolean docs)
boolean
fieldData()
IndicesStatsRequest
fieldData(boolean fieldData)
java.lang.String[]
fieldDataFields()
IndicesStatsRequest
fieldDataFields(java.lang.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)
java.lang.String[]
groups()
IndicesStatsRequest
groups(java.lang.String... groups)
Sets specific search group stats to retrieve the stats for.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)
java.lang.String[]
types()
Document types to return stats for.IndicesStatsRequest
types(java.lang.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, validate
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
IndicesStatsRequest
public IndicesStatsRequest() -
IndicesStatsRequest
- Throws:
java.io.IOException
-
-
Method Details
-
all
Sets all flags to return all stats. -
clear
Clears all stats. -
flags
Returns the underlying stats flags. -
flags
Sets the underlying stats flags. -
types
Document types to return stats for. Mainly affectsindexing(boolean)
when enabled, returning specific indexing stats for those types. -
types
public java.lang.String[] types()Document types to return stats for. Mainly affectsindexing(boolean)
when enabled, returning specific indexing stats for those types. -
groups
Sets specific search group stats to retrieve the stats for. Mainly affects search when enabled. -
groups
public java.lang.String[] groups() -
docs
-
docs
public boolean docs() -
store
-
store
public boolean store() -
indexing
-
indexing
public boolean indexing() -
get
-
get
public boolean get() -
search
-
search
public boolean search() -
merge
-
merge
public boolean merge() -
refresh
-
refresh
public boolean refresh() -
flush
-
flush
public boolean flush() -
warmer
-
warmer
public boolean warmer() -
queryCache
-
queryCache
public boolean queryCache() -
fieldData
-
fieldData
public boolean fieldData() -
segments
-
segments
public boolean segments() -
fieldDataFields
-
fieldDataFields
public java.lang.String[] fieldDataFields() -
completion
-
completion
public boolean completion() -
completionFields
-
completionFields
public java.lang.String[] completionFields() -
translog
-
translog
public boolean translog() -
requestCache
-
requestCache
public boolean requestCache() -
recovery
-
recovery
public boolean recovery() -
includeSegmentFileSizes
public boolean includeSegmentFileSizes() -
includeSegmentFileSizes
-
includeUnloadedSegments
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classBroadcastRequest<IndicesStatsRequest>
- Throws:
java.io.IOException
-