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()
If true, the API performs a flush before analysis.final Boolean
If true, missing or closed indices are not included in the response.final String
index()
Required - Comma-separated list of data streams, indices, and aliases used to limit the request.final TimeUnit
Period to wait for a connection to the master node.static DiskUsageRequest
final Boolean
Analyzing field disk usage is resource-intensive.final TimeUnit
timeout()
Period to wait for a response.final String
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
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 targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.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 as open,hidden.API name:
expand_wildcards
-
flush
If true, the API performs a flush before analysis. If false, 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
-
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
-
runExpensiveTasks
Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true.API name:
run_expensive_tasks
-
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). Default: 1, the primary shard.API name:
wait_for_active_shards
-