Package co.elastic.clients.elasticsearch.indices

Class FieldUsageStatsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.FieldUsageStatsRequest

public class FieldUsageStatsRequest
extends RequestBase

Get field usage stats. Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.

The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldUsageStatsRequest.Builder	Builder for FieldUsageStatsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<FieldUsageStatsRequest,FieldUsageStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.field_usage_stats".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final List<String>	fields()	Comma-separated list or wildcard expressions of fields to include in the statistics.
final Boolean	ignoreUnavailable()	If true, missing or closed indices are not included in the response.
final List<String>	index()	Required - Comma-separated list or wildcard expression of index names used to limit the request.
static FieldUsageStatsRequest	of(Function<FieldUsageStatsRequest.Builder,ObjectBuilder<FieldUsageStatsRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<FieldUsageStatsRequest,FieldUsageStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.field_usage_stats".

Method Details

of

public static FieldUsageStatsRequest of(Function<FieldUsageStatsRequest.Builder,ObjectBuilder<FieldUsageStatsRequest>> fn)

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

API name: allow_no_indices

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

fields

public final List<String> fields()

Comma-separated list or wildcard expressions of fields to include in the statistics.

API name: fields

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If true, missing or closed indices are not included in the response.

API name: ignore_unavailable

index

public final List<String> index()

Required - Comma-separated list or wildcard expression of index names used to limit the request.

API name: index