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
Get the field capabilities.

Get information about the capabilities of fields among multiple indices.

For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same 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()
      The 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()
      A list of fields to retrieve capabilities for. Wildcard (*) expressions are supported.

      API name: fields

    • filters

      @Nullable public final String filters()
      A comma-separated list of filters to apply to the response.

      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

    • includeEmptyFields

      @Nullable public final Boolean includeEmptyFields()
      If false, empty fields are not included in the response.

      API name: include_empty_fields

    • 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()
      A 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()
      Filter indices if the provided query rewrites to match_none on every shard.

      IMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to match_none instead of fully running the request. For instance a range query over a date field can rewrite to match_none if all documents within a shard (including deleted documents) are outside of the provided range. However, not all queries can rewrite to match_none so this API may return an index even if the provided filter matches no document.

      API name: index_filter

    • projectRouting

      @Nullable public final String projectRouting()
      Specifies a subset of projects to target for the field-caps query using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      API name: project_routing

    • runtimeMappings

      public final Map<String,RuntimeField> runtimeMappings()
      Define 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()
      A comma-separated list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned.

      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)