Package org.opensearch.client.opensearch.indices

Class DiskUsageRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • allowNoIndices

        public final DiskUsageRequest.Builder allowNoIndices​(@Nullable
                                                     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. 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 DiskUsageRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
        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 to expandWildcards.

      • 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

        public final DiskUsageRequest.Builder flush​(@Nullable
                                            java.lang.Boolean value)
        If true, the API performs a flush before analysis. If false, the response may not include uncommitted data.

        API name: flush

      • ignoreUnavailable

        public final DiskUsageRequest.Builder ignoreUnavailable​(@Nullable
                                                        java.lang.Boolean value)
        If true, missing or closed indices are not included in the response.

        API name: ignore_unavailable

      • index

        public final DiskUsageRequest.Builder index​(java.lang.String value)
        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

        @Deprecated
public final DiskUsageRequest.Builder masterTimeout​(@Nullable
                                                    TimeUnit value)
        Deprecated.
        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

      • clusterManagerTimeout

        public final DiskUsageRequest.Builder clusterManagerTimeout​(@Nullable
                                                            TimeUnit value)
        Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

        API name: cluster_manager_timeout

      • runExpensiveTasks

        public final DiskUsageRequest.Builder runExpensiveTasks​(@Nullable
                                                        java.lang.Boolean value)
        Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true.

        API name: run_expensive_tasks

      • timeout

        public final DiskUsageRequest.Builder timeout​(@Nullable
                                              TimeUnit value)
        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

        public final DiskUsageRequest.Builder waitForActiveShards​(@Nullable
                                                          java.lang.String value)
        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