Class DiskUsageRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.DiskUsageRequest
Analyzes the disk usage of each field of an index or data stream.
- 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<DiskUsageRequest,
DiskUsageResponse, ErrorResponse> Endpoint "indices.disk_usage
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
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>
Type of index that wildcard patterns can match.final Boolean
flush()
Iftrue
, the API performs a flush before analysis.final Boolean
Iftrue
, missing or closed indices are not included in the response.index()
Required - Comma-separated list of data streams, indices, and aliases used to limit the request.static DiskUsageRequest
final Boolean
Analyzing field disk usage is resource-intensive.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "indices.disk_usage
".
-
-
Method Details
-
of
public static DiskUsageRequest of(Function<DiskUsageRequest.Builder, ObjectBuilder<DiskUsageRequest>> fn) -
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 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
-
flush
Iftrue
, the API performs a flush before analysis. Iffalse
, the response may not include uncommitted data.API name:
flush
-
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
Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set totrue
.API name:
run_expensive_tasks
-