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
Returns the information about the capabilities of fields among multiple indices.
See Also:
API specification

  • Field Details

  • 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

      public final java.util.List<ExpandWildcard> 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()
      Required - A comma-separated list of field names

      API name: fields

    • ignoreUnavailable

      @Nullable public final java.lang.Boolean ignoreUnavailable()
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • 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 indices

      API name: index

    • indexFilter

      @Nullable public final Query indexFilter()
      API name: index_filter

    • runtimeMappings

      public final java.util.Map<java.lang.String,​RuntimeField> runtimeMappings()
      API name: runtime_mappings

    • 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)