Class FieldUsageStatsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<FieldUsageStatsRequest.Builder>
co.elastic.clients.elasticsearch.indices.FieldUsageStatsRequest.Builder
- All Implemented Interfaces:
WithJson<FieldUsageStatsRequest.Builder>
,ObjectBuilder<FieldUsageStatsRequest>
- Enclosing class:
- FieldUsageStatsRequest
public static class FieldUsageStatsRequest.Builder
extends RequestBase.AbstractBuilder<FieldUsageStatsRequest.Builder>
implements ObjectBuilder<FieldUsageStatsRequest>
Builder for
FieldUsageStatsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.build()
Builds aFieldUsageStatsRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.Comma-separated list or wildcard expressions of fields to include in the statistics.Comma-separated list or wildcard expressions of fields to include in the statistics.ignoreUnavailable
(Boolean value) If true, missing or closed indices are not included in the response.Required - Comma-separated list or wildcard expression of index names used to limit the request.Required - Comma-separated list or wildcard expression of index names used to limit the request.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.protected FieldUsageStatsRequest.Builder
self()
Period to wait for a response.Period to wait for a response.The number of shard copies that must be active before proceeding with the operation.The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
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 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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final FieldUsageStatsRequest.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 asopen,hidden
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
fields
Comma-separated list or wildcard expressions of fields to include in the statistics.API name:
fields
Adds all elements of
list
tofields
. -
fields
Comma-separated list or wildcard expressions of fields to include in the statistics.API name:
fields
Adds one or more values to
fields
. -
index
Required - Comma-separated list or wildcard expression of index names used to limit the request.API name:
index
Adds all elements of
list
toindex
. -
index
Required - Comma-separated list or wildcard expression of index names used to limit the request.API name:
index
Adds one or more values to
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
-
masterTimeout
public final FieldUsageStatsRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) 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
-
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
-
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
public final FieldUsageStatsRequest.Builder waitForActiveShards(@Nullable WaitForActiveShards 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
).API name:
wait_for_active_shards
-
waitForActiveShards
public final FieldUsageStatsRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) 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
).API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<FieldUsageStatsRequest.Builder>
-
build
Builds aFieldUsageStatsRequest
.- Specified by:
build
in interfaceObjectBuilder<FieldUsageStatsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-