Class FieldUsageStatsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.FieldUsageStatsRequest
Returns field usage information for each shard and field of an index.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<FieldUsageStatsRequest,
FieldUsageStatsResponse, ErrorResponse> Endpoint "indices.field_usage_stats
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final List<ExpandWildcard>
Type of index that wildcard patterns can match.fields()
Comma-separated list or wildcard expressions of fields to include in the statistics.final Boolean
Iftrue
, missing or closed indices are not included in the response.index()
Required - Comma-separated list or wildcard expression of index names used to limit the request.final Time
Period to wait for a connection to the master node.static FieldUsageStatsRequest
final Time
timeout()
Period to wait for a response.final WaitForActiveShards
The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<FieldUsageStatsRequest,FieldUsageStatsResponse, _ENDPOINTErrorResponse> Endpoint "indices.field_usage_stats
".
-
-
Method Details
-
of
public static FieldUsageStatsRequest of(Function<FieldUsageStatsRequest.Builder, ObjectBuilder<FieldUsageStatsRequest>> fn) -
allowNoIndices
Iffalse
, 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 targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
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 asopen,hidden
.API name:
expand_wildcards
-
fields
Comma-separated list or wildcard expressions of fields to include in the statistics.API name:
fields
-
index
Required - Comma-separated list or wildcard expression of index names used to limit the request.API name:
index
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
waitForActiveShards
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-