Class FieldCapsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<FieldCapsRequest.Builder>
co.elastic.clients.elasticsearch.core.FieldCapsRequest.Builder
- All Implemented Interfaces:
WithJson<FieldCapsRequest.Builder>
,ObjectBuilder<FieldCapsRequest>
- Enclosing class:
- FieldCapsRequest
public static class FieldCapsRequest.Builder
extends RequestBase.AbstractBuilder<FieldCapsRequest.Builder>
implements ObjectBuilder<FieldCapsRequest>
Builder for
FieldCapsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal FieldCapsRequest.Builder
allowNoIndices
(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 aFieldCapsRequest
.final FieldCapsRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.final FieldCapsRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.final FieldCapsRequest.Builder
Comma-separated list of fields to retrieve capabilities for.final FieldCapsRequest.Builder
Comma-separated list of fields to retrieve capabilities for.final FieldCapsRequest.Builder
ignoreUnavailable
(Boolean value) Iftrue
, missing or closed indices are not included in the response.final FieldCapsRequest.Builder
includeUnmapped
(Boolean value) If true, unmapped fields are included in the response.final FieldCapsRequest.Builder
Comma-separated list of data streams, indices, and aliases used to limit the request.final FieldCapsRequest.Builder
Comma-separated list of data streams, indices, and aliases used to limit the request.final FieldCapsRequest.Builder
indexFilter
(Query value) Allows to filter indices if the provided query rewrites to match_none on every shard.final FieldCapsRequest.Builder
Allows to filter indices if the provided query rewrites to match_none on every shard.final FieldCapsRequest.Builder
runtimeMappings
(String key, RuntimeField value) Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.final FieldCapsRequest.Builder
Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.final FieldCapsRequest.Builder
runtimeMappings
(Map<String, RuntimeField> map) Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.protected FieldCapsRequest.Builder
self()
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 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 asopen,hidden
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final FieldCapsRequest.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 of fields to retrieve capabilities for. Wildcard (*
) expressions are supported.API name:
fields
Adds all elements of
list
tofields
. -
fields
Comma-separated list of fields to retrieve capabilities for. Wildcard (*
) expressions are supported.API name:
fields
Adds one or more values to
fields
. -
includeUnmapped
If true, unmapped fields are included in the response.API name:
include_unmapped
-
index
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.API name:
index
Adds all elements of
list
toindex
. -
index
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.API name:
index
Adds one or more values to
index
. -
indexFilter
Allows to filter indices if the provided query rewrites to match_none on every shard.API name:
index_filter
-
indexFilter
Allows to filter indices if the provided query rewrites to match_none on every shard.API name:
index_filter
-
runtimeMappings
Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.API name:
runtime_mappings
Adds all entries of
map
toruntimeMappings
. -
runtimeMappings
Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.API name:
runtime_mappings
Adds an entry to
runtimeMappings
. -
runtimeMappings
public final FieldCapsRequest.Builder runtimeMappings(String key, Function<RuntimeField.Builder, ObjectBuilder<RuntimeField>> fn) Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.API name:
runtime_mappings
Adds an entry to
runtimeMappings
using a builder lambda. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<FieldCapsRequest.Builder>
-
build
Builds aFieldCapsRequest
.- Specified by:
build
in interfaceObjectBuilder<FieldCapsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-