Class FieldCapsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.FieldCapsRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class FieldCapsRequest extends RequestBase implements JsonpSerializable
The field capabilities API returns the information about the capabilities of
fields among multiple indices. The field capabilities API returns runtime
fields like any other field. For example, a runtime field with a type of
keyword is returned as any other field that belongs to the
keyword
family.- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FieldCapsRequest.Builder
Builder forFieldCapsRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<FieldCapsRequest>
_DESERIALIZER
Json deserializer forFieldCapsRequest
static Endpoint<FieldCapsRequest,FieldCapsResponse,ErrorResponse>
_ENDPOINT
Endpoint "field_caps
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
If false, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.java.util.List<ExpandWildcard>
expandWildcards()
Type of index that wildcard patterns can match.java.util.List<java.lang.String>
fields()
Required - Comma-separated list of fields to retrieve capabilities for.java.lang.String
filters()
An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parentjava.lang.Boolean
ignoreUnavailable()
Iftrue
, missing or closed indices are not included in the response.java.lang.Boolean
includeUnmapped()
If true, unmapped fields are included in the response.java.util.List<java.lang.String>
index()
Comma-separated list of data streams, indices, and aliases used to limit the request.Query
indexFilter()
Allows to filter indices if the provided query rewrites to match_none on every shard.static FieldCapsRequest
of(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)
java.util.Map<java.lang.String,java.util.List<RuntimeField>>
runtimeMappings()
Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupFieldCapsRequestDeserializer(ObjectDeserializer<FieldCapsRequest.Builder> op)
java.util.List<java.lang.String>
types()
Only return results for fields that have one of the types in the listMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forFieldCapsRequest
-
_ENDPOINT
Endpoint "field_caps
".
-
-
Method Details
-
of
public static FieldCapsRequest of(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn) -
allowNoIndices
@Nullable public final java.lang.Boolean 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
-
fields
public final java.util.List<java.lang.String> fields()Required - Comma-separated list of fields to retrieve capabilities for. Wildcard (*
) expressions are supported.API name:
fields
-
filters
@Nullable public final java.lang.String filters()An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parentAPI name:
filters
-
includeUnmapped
@Nullable public final java.lang.Boolean includeUnmapped()If true, unmapped fields are included in the response.API name:
include_unmapped
-
index
public final java.util.List<java.lang.String> 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
-
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
-
types
public final java.util.List<java.lang.String> types()Only return results for fields that have one of the types in the listAPI name:
types
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupFieldCapsRequestDeserializer
protected static void setupFieldCapsRequestDeserializer(ObjectDeserializer<FieldCapsRequest.Builder> op)
-