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 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(List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

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

      Adds one or more values to expandWildcards.

    • fields

      public final FieldCapsRequest.Builder fields(List<String> list)
      A 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(String value, String... values)
      A 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 String value)
      A comma-separated list of filters to apply to the response.

      API name: filters

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeEmptyFields

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

      API name: include_empty_fields

    • includeUnmapped

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

      API name: include_unmapped

    • index

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

      Adds all elements of list to index.

    • index

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

      Adds one or more values to index.

    • indexFilter

      public final FieldCapsRequest.Builder indexFilter(@Nullable Query value)
      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

    • indexFilter

      public final FieldCapsRequest.Builder indexFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)
      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

    • indexFilter

      public final FieldCapsRequest.Builder indexFilter(QueryVariant value)
      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

      public final FieldCapsRequest.Builder projectRouting(@Nullable String value)
      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 FieldCapsRequest.Builder runtimeMappings(Map<String,RuntimeField> map)
      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

      Adds all entries of map to runtimeMappings.

    • runtimeMappings

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

      Adds an entry to runtimeMappings.

    • runtimeMappings

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

      Adds an entry to runtimeMappings using a builder lambda.

    • types

      public final FieldCapsRequest.Builder types(List<String> list)
      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

      Adds all elements of list to types.

    • types

      public final FieldCapsRequest.Builder types(String value, String... values)
      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

      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:
      NullPointerException - if some of the required fields are null.