Package co.elastic.clients.elasticsearch.indices

Class GetFieldMappingRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest
public class GetFieldMappingRequest extends RequestBase
Get mapping definitions.

Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      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()
      Required - Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (*).

      API name: fields

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • includeDefaults

      @Nullable public final Boolean includeDefaults()
      If true, return all default settings in the response.

      API name: include_defaults

    • 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

    • rebuild

      public GetFieldMappingRequest.Builder rebuild()
      Returns:
      New GetFieldMappingRequest.Builder initialized with field values of this instance