Class FieldCapsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.FieldCapsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<FieldCapsRequest>
- Enclosing class:
- FieldCapsRequest
public static class FieldCapsRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<FieldCapsRequest>
Builder for
FieldCapsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description FieldCapsRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.FieldCapsRequest
build()
Builds aFieldCapsRequest
.FieldCapsRequest.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Whether to expand wildcard expression to concrete indices that are open, closed or both.FieldCapsRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Whether to expand wildcard expression to concrete indices that are open, closed or both.FieldCapsRequest.Builder
fields(java.lang.String value, java.lang.String... values)
A comma-separated list of field namesFieldCapsRequest.Builder
fields(java.util.List<java.lang.String> list)
A comma-separated list of field namesFieldCapsRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)FieldCapsRequest.Builder
includeUnmapped(java.lang.Boolean value)
Indicates whether unmapped fields should be included in the response.FieldCapsRequest.Builder
index(java.lang.String value, java.lang.String... values)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesFieldCapsRequest.Builder
index(java.util.List<java.lang.String> list)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesFieldCapsRequest.Builder
indexFilter(Query value)
API name:index_filter
FieldCapsRequest.Builder
indexFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
API name:index_filter
FieldCapsRequest.Builder
runtimeMappings(java.lang.String key, RuntimeField value)
API name:runtime_mappings
FieldCapsRequest.Builder
runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)
API name:runtime_mappings
FieldCapsRequest.Builder
runtimeMappings(java.util.Map<java.lang.String,RuntimeField> map)
API name:runtime_mappings
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
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final FieldCapsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
fields
A comma-separated list of field namesAPI name:
fields
Adds all elements of
list
tofields
. -
fields
A comma-separated list of field namesAPI name:
fields
Adds one or more values to
fields
. -
includeUnmapped
Indicates whether unmapped fields should be included in the response.API name:
include_unmapped
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds all elements of
list
toindex
. -
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds one or more values to
index
. -
indexFilter
API name:index_filter
-
indexFilter
public final FieldCapsRequest.Builder indexFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:index_filter
-
runtimeMappings
public final FieldCapsRequest.Builder runtimeMappings(java.util.Map<java.lang.String,RuntimeField> map)API name:runtime_mappings
Adds all entries of
map
toruntimeMappings
. -
runtimeMappings
API name:runtime_mappings
Adds an entry to
runtimeMappings
. -
runtimeMappings
public final FieldCapsRequest.Builder runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)API name:runtime_mappings
Adds an entry to
runtimeMappings
using a builder lambda. -
build
Builds aFieldCapsRequest
.- Specified by:
build
in interfaceObjectBuilder<FieldCapsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-