Package co.elastic.clients.elasticsearch.core

Class FieldCapsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<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 RequestBase.AbstractBuilder<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)
      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 FieldCapsRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final FieldCapsRequest.Builder expandWildcards​(ExpandWildcard value, ExpandWildcard... values)
      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

      Adds one or more values to expandWildcards.

    • fields

      public final FieldCapsRequest.Builder fields​(java.util.List<java.lang.String> list)
      List of fields to retrieve capabilities for. Wildcard (*) expressions are supported.

      API name: fields

      Adds all elements of list to fields.

    • fields

      public final FieldCapsRequest.Builder fields​(java.lang.String value, java.lang.String... values)
      List of fields to retrieve capabilities for. Wildcard (*) expressions are supported.

      API name: fields

      Adds one or more values to fields.

    • filters

      public final FieldCapsRequest.Builder filters​(@Nullable java.lang.String value)
      An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent

      API name: filters

    • ignoreUnavailable

      public final FieldCapsRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • includeUnmapped

      public final FieldCapsRequest.Builder includeUnmapped​(@Nullable java.lang.Boolean value)
      If true, unmapped fields are included in the response.

      API name: include_unmapped

    • index

      public final FieldCapsRequest.Builder index​(java.util.List<java.lang.String> list)
      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

      Adds all elements of list to index.

    • index

      public final FieldCapsRequest.Builder index​(java.lang.String value, java.lang.String... values)
      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

      Adds one or more values to index.

    • indexFilter

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

      API name: index_filter

    • indexFilter

      public final FieldCapsRequest.Builder indexFilter​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      Allows to filter indices if the provided query rewrites to match_none on every shard.

      API name: index_filter

    • runtimeMappings

      public final FieldCapsRequest.Builder runtimeMappings​(java.util.Map<java.lang.String,​RuntimeField> map)
      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

      Adds all entries of map to runtimeMappings.

    • runtimeMappings

      public final FieldCapsRequest.Builder runtimeMappings​(java.lang.String key, RuntimeField value)
      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

      Adds an entry to runtimeMappings.

    • runtimeMappings

      public final FieldCapsRequest.Builder runtimeMappings​(java.lang.String key, java.util.function.Function<RuntimeField.Builder,​ObjectBuilder<RuntimeField>> fn)
      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

      Adds an entry to runtimeMappings using a builder lambda.

    • types

      public final FieldCapsRequest.Builder types​(java.util.List<java.lang.String> list)
      Only return results for fields that have one of the types in the list

      API name: types

      Adds all elements of list to types.

    • types

      public final FieldCapsRequest.Builder types​(java.lang.String value, java.lang.String... values)
      Only return results for fields that have one of the types in the list

      API name: types

      Adds one or more values to types.

    • self

      protected FieldCapsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<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.