Class DiskUsageRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.indices.DiskUsageRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<DiskUsageRequest>
- Enclosing class:
- DiskUsageRequest
public static class DiskUsageRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<DiskUsageRequest>
Builder for
DiskUsageRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description DiskUsageRequest.Builder
allowNoIndices(java.lang.Boolean value)
If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.DiskUsageRequest
build()
Builds aDiskUsageRequest
.DiskUsageRequest.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Type of index that wildcard patterns can match.DiskUsageRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Type of index that wildcard patterns can match.DiskUsageRequest.Builder
flush(java.lang.Boolean value)
If true, the API performs a flush before analysis.DiskUsageRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
If true, missing or closed indices are not included in the response.DiskUsageRequest.Builder
index(java.lang.String value)
Required - Comma-separated list of data streams, indices, and aliases used to limit the request.DiskUsageRequest.Builder
masterTimeout(TimeUnit value)
Period to wait for a connection to the master node.DiskUsageRequest.Builder
runExpensiveTasks(java.lang.Boolean value)
Analyzing field disk usage is resource-intensive.DiskUsageRequest.Builder
timeout(TimeUnit value)
Period to wait for a response.DiskUsageRequest.Builder
waitForActiveShards(java.lang.String value)
The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final DiskUsageRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)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
Adds one or more values to
expandWildcards
. -
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
-
build
Builds aDiskUsageRequest
.- Specified by:
build
in interfaceObjectBuilder<DiskUsageRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-