Package org.opensearch.action.admin.indices.stats

Class IndicesStatsRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<Request,Response>

org.opensearch.action.support.broadcast.BroadcastOperationRequestBuilder<IndicesStatsRequest,IndicesStatsResponse,IndicesStatsRequestBuilder>

org.opensearch.action.admin.indices.stats.IndicesStatsRequestBuilder

public class IndicesStatsRequestBuilder
extends BroadcastOperationRequestBuilder<IndicesStatsRequest,IndicesStatsResponse,IndicesStatsRequestBuilder>

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

By default, the setDocs(boolean), setStore(boolean), setIndexing(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.

Opensearch.internal:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
IndicesStatsRequestBuilder(OpenSearchClient client, IndicesStatsAction action)

Method Summary

Modifier and Type	Method	Description
IndicesStatsRequestBuilder	all()	Sets all flags to return all stats.
IndicesStatsRequestBuilder	clear()	Clears all stats.
IndicesStatsRequestBuilder	setCompletion(boolean completion)
IndicesStatsRequestBuilder	setCompletionFields(String... fields)
IndicesStatsRequestBuilder	setDocs(boolean docs)
IndicesStatsRequestBuilder	setFieldData(boolean fieldData)
IndicesStatsRequestBuilder	setFieldDataFields(String... fields)
IndicesStatsRequestBuilder	setFlush(boolean flush)
IndicesStatsRequestBuilder	setGet(boolean get)
IndicesStatsRequestBuilder	setGroups(String... groups)
IndicesStatsRequestBuilder	setIncludeSegmentFileSizes(boolean includeSegmentFileSizes)
IndicesStatsRequestBuilder	setIndexing(boolean indexing)
IndicesStatsRequestBuilder	setMerge(boolean merge)
IndicesStatsRequestBuilder	setQueryCache(boolean queryCache)
IndicesStatsRequestBuilder	setRecovery(boolean recovery)
IndicesStatsRequestBuilder	setRefresh(boolean refresh)
IndicesStatsRequestBuilder	setRequestCache(boolean requestCache)
IndicesStatsRequestBuilder	setSearch(boolean search)
IndicesStatsRequestBuilder	setSegments(boolean segments)
IndicesStatsRequestBuilder	setStore(boolean store)
final IndicesStatsRequestBuilder	setTimeout(org.opensearch.common.unit.TimeValue timeout)	Sets timeout of request.
IndicesStatsRequestBuilder	setTranslog(boolean translog)
IndicesStatsRequestBuilder	setWarmer(boolean warmer)

Methods inherited from class org.opensearch.action.support.broadcast.BroadcastOperationRequestBuilder

setIndices, setIndicesOptions

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

IndicesStatsRequestBuilder

public IndicesStatsRequestBuilder(OpenSearchClient client,
 IndicesStatsAction action)

Method Details

all

public IndicesStatsRequestBuilder all()

Sets all flags to return all stats.

clear

public IndicesStatsRequestBuilder clear()

Clears all stats.

setTimeout

public final IndicesStatsRequestBuilder setTimeout(org.opensearch.common.unit.TimeValue timeout)

Sets timeout of request.

setGroups

public IndicesStatsRequestBuilder setGroups(String... groups)

setDocs

public IndicesStatsRequestBuilder setDocs(boolean docs)

setStore

public IndicesStatsRequestBuilder setStore(boolean store)

setIndexing

public IndicesStatsRequestBuilder setIndexing(boolean indexing)

setGet

public IndicesStatsRequestBuilder setGet(boolean get)

setSearch

public IndicesStatsRequestBuilder setSearch(boolean search)

setMerge

public IndicesStatsRequestBuilder setMerge(boolean merge)

setRefresh

public IndicesStatsRequestBuilder setRefresh(boolean refresh)

setFlush

public IndicesStatsRequestBuilder setFlush(boolean flush)

setWarmer

public IndicesStatsRequestBuilder setWarmer(boolean warmer)

setQueryCache

public IndicesStatsRequestBuilder setQueryCache(boolean queryCache)

setFieldData

public IndicesStatsRequestBuilder setFieldData(boolean fieldData)

setFieldDataFields

public IndicesStatsRequestBuilder setFieldDataFields(String... fields)

setSegments

public IndicesStatsRequestBuilder setSegments(boolean segments)

setCompletion

public IndicesStatsRequestBuilder setCompletion(boolean completion)

setCompletionFields

public IndicesStatsRequestBuilder setCompletionFields(String... fields)

setTranslog

public IndicesStatsRequestBuilder setTranslog(boolean translog)

setRequestCache

public IndicesStatsRequestBuilder setRequestCache(boolean requestCache)

setRecovery

public IndicesStatsRequestBuilder setRecovery(boolean recovery)

setIncludeSegmentFileSizes

public IndicesStatsRequestBuilder setIncludeSegmentFileSizes(boolean includeSegmentFileSizes)