Package co.elastic.clients.elasticsearch.core

Class FieldCapsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<FieldCapsRequest.Builder>
co.elastic.clients.elasticsearch.core.FieldCapsRequest.Builder
All Implemented Interfaces:
WithJson<FieldCapsRequest.Builder>, ObjectBuilder<FieldCapsRequest>
Enclosing class:
FieldCapsRequest
public static class FieldCapsRequest.Builder
extends WithJsonObjectBuilderBase<FieldCapsRequest.Builder>
implements ObjectBuilder<FieldCapsRequest>
Builder for FieldCapsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final FieldCapsRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      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 FieldCapsRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final FieldCapsRequest.Builder expandWildcards​(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • fields

      public final FieldCapsRequest.Builder fields​(java.util.List<java.lang.String> list)
      Required - A comma-separated list of field names

      API name: fields

      Adds all elements of list to fields.

    • fields

      public final FieldCapsRequest.Builder fields​(java.lang.String value, java.lang.String... values)
      Required - A comma-separated list of field names

      API name: fields

      Adds one or more values to fields.

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeUnmapped

      public final FieldCapsRequest.Builder includeUnmapped​(@Nullable java.lang.Boolean value)
      Indicates whether unmapped fields should be included in the response.

      API name: include_unmapped

    • index

      public final FieldCapsRequest.Builder index​(java.util.List<java.lang.String> list)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

      Adds all elements of list to index.

    • index

      public final FieldCapsRequest.Builder index​(java.lang.String value, java.lang.String... values)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

      Adds one or more values to index.

    • indexFilter

      public final FieldCapsRequest.Builder indexFilter​(@Nullable Query value)
      API name: index_filter

    • indexFilter

      public final FieldCapsRequest.Builder indexFilter​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      API name: index_filter

    • runtimeMappings

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

      Adds all entries of map to runtimeMappings.

    • runtimeMappings

      public final FieldCapsRequest.Builder runtimeMappings​(java.lang.String key, RuntimeField value)
      API name: runtime_mappings

      Adds an entry to runtimeMappings.

    • runtimeMappings

      public final FieldCapsRequest.Builder runtimeMappings​(java.lang.String key, java.util.function.Function<RuntimeField.Builder,​ObjectBuilder<RuntimeField>> fn)
      API name: runtime_mappings

      Adds an entry to runtimeMappings using a builder lambda.

    • self

      protected FieldCapsRequest.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<FieldCapsRequest.Builder>

    • build

      public FieldCapsRequest build()
      Builds a FieldCapsRequest.
      Specified by:
      build in interface ObjectBuilder<FieldCapsRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.