Package co.elastic.clients.elasticsearch.core

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:

  • Field Details

  • Method Details

    • of

      public static FieldCapsRequest of(Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)

    • allowNoIndices

      @Nullable public final 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 targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> 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 as open,hidden.

      API name: expand_wildcards

    • fields

      public final List<String> fields()
      List of fields to retrieve capabilities for. Wildcard (*) expressions are supported.

      API name: fields

    • filters

      @Nullable public final String filters()
      An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent

      API name: filters

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • includeUnmapped

      @Nullable public final Boolean includeUnmapped()
      If true, unmapped fields are included in the response.

      API name: include_unmapped

    • index

      public final List<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

      @Nullable public final Query indexFilter()
      Allows to filter indices if the provided query rewrites to match_none on every shard.

      API name: index_filter

    • runtimeMappings

      public final Map<String,RuntimeField> 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 List<String> types()
      Only return results for fields that have one of the types in the list

      API name: types

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupFieldCapsRequestDeserializer

      protected static void setupFieldCapsRequestDeserializer(ObjectDeserializer<FieldCapsRequest.Builder> op)