Package co.elastic.clients.elasticsearch.indices

Class DiskUsageRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.DiskUsageRequest

public class DiskUsageRequest
extends RequestBase

Analyzes the disk usage of each field of an index or data stream.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DiskUsageRequest,DiskUsageResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.disk_usage".

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 Boolean	flush()	If true, the API performs a flush before analysis.
final Boolean	ignoreUnavailable()	If true, missing or closed indices are not included in the response.
final List<String>	index()	Required - Comma-separated list of data streams, indices, and aliases used to limit the request.
static DiskUsageRequest	of(Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> fn)
final Boolean	runExpensiveTasks()	Analyzing field disk usage is resource-intensive.

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<DiskUsageRequest,DiskUsageResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.disk_usage".

Method Details

of

public static DiskUsageRequest of(Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> 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

flush

@Nullable
public final Boolean flush()

If true, the API performs a flush before analysis. If false, the response may not include uncommitted data.

API name: flush

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 of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly.

API name: index

runExpensiveTasks

@Nullable
public final Boolean runExpensiveTasks()

Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true.

API name: run_expensive_tasks