Package org.opensearch.client.opensearch.core

Class FieldCapsRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<FieldCapsRequest.Builder>
org.opensearch.client.opensearch.core.FieldCapsRequest.Builder
All Implemented Interfaces:
CopyableBuilder<FieldCapsRequest.Builder,FieldCapsRequest>, MutableBuilder<FieldCapsRequest.Builder,FieldCapsRequest>, ObjectBuilder<FieldCapsRequest>
Enclosing class:
FieldCapsRequest
public static class FieldCapsRequest.Builder extends RequestBase.AbstractBuilder<FieldCapsRequest.Builder> implements CopyableBuilder<FieldCapsRequest.Builder,FieldCapsRequest>
Builder for FieldCapsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public FieldCapsRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<FieldCapsRequest.Builder,FieldCapsRequest>
      Returns:
      a new builder instance.

    • self

      @Nonnull protected FieldCapsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<FieldCapsRequest.Builder>

    • allowNoIndices

      @Nonnull 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 indexes. This behavior applies even if the request targets other open indexes. 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

      @Nonnull public final FieldCapsRequest.Builder expandWildcards(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

      @Nonnull 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

      @Nonnull public final FieldCapsRequest.Builder fields(List<String> list)
      API name: fields

      Adds all elements of list to fields.

    • fields

      @Nonnull public final FieldCapsRequest.Builder fields(String value, String... values)
      API name: fields

      Adds one or more values to fields.

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeUnmapped

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

      API name: include_unmapped

    • index

      @Nonnull public final FieldCapsRequest.Builder index(List<String> list)
      Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

      Adds all elements of list to index.

    • index

      @Nonnull public final FieldCapsRequest.Builder index(String value, String... values)
      Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

      Adds one or more values to index.

    • indexFilter

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

    • indexFilter

      @Nonnull public final FieldCapsRequest.Builder indexFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)
      API name: index_filter

    • build

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