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
Returns the information about the capabilities of fields among multiple
indices.
- 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()
Whether to ignore if a wildcard indices expression resolves into no concrete indices.java.util.List<ExpandWildcard>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.java.util.List<java.lang.String>
fields()
A comma-separated list of field namesjava.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.lang.Boolean
includeUnmapped()
Indicates whether unmapped fields should be included in the response.java.util.List<java.lang.String>
index()
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesQuery
indexFilter()
API name:index_filter
static FieldCapsRequest
of(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)
java.util.Map<java.lang.String,RuntimeField>
runtimeMappings()
API name:runtime_mappings
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)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()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
-
fields
public final java.util.List<java.lang.String> fields()A comma-separated list of field namesAPI name:
fields
-
includeUnmapped
@Nullable public final java.lang.Boolean includeUnmapped()Indicates whether unmapped fields should be included in the response.API name:
include_unmapped
-
index
public final java.util.List<java.lang.String> index()A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
indexFilter
API name:index_filter
-
runtimeMappings
API name:runtime_mappings
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupFieldCapsRequestDeserializer
protected static void setupFieldCapsRequestDeserializer(ObjectDeserializer<FieldCapsRequest.Builder> op)
-