Package co.elastic.clients.elasticsearch.indices

Class GetFieldMappingRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetFieldMappingRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest.Builder
All Implemented Interfaces:
WithJson<GetFieldMappingRequest.Builder>, ObjectBuilder<GetFieldMappingRequest>
Enclosing class:
GetFieldMappingRequest
public static class GetFieldMappingRequest.Builder extends RequestBase.AbstractBuilder<GetFieldMappingRequest.Builder> implements ObjectBuilder<GetFieldMappingRequest>
Builder for GetFieldMappingRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final GetFieldMappingRequest.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.

      API name: allow_no_indices

    • expandWildcards

      public final GetFieldMappingRequest.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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final GetFieldMappingRequest.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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • fields

      public final GetFieldMappingRequest.Builder fields(List<String> list)
      Required - Comma-separated list or wildcard expression of fields used to limit returned information.

      API name: fields

      Adds all elements of list to fields.

    • fields

      public final GetFieldMappingRequest.Builder fields(String value, String... values)
      Required - Comma-separated list or wildcard expression of fields used to limit returned information.

      API name: fields

      Adds one or more values to fields.

    • ignoreUnavailable

      public final GetFieldMappingRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • includeDefaults

      public final GetFieldMappingRequest.Builder includeDefaults(@Nullable Boolean value)
      If true, return all default settings in the response.

      API name: include_defaults

    • index

      public final GetFieldMappingRequest.Builder index(List<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 GetFieldMappingRequest.Builder index(String value, 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.

    • local

      public final GetFieldMappingRequest.Builder local(@Nullable Boolean value)
      If true, the request retrieves information from the local node only.

      API name: local

    • self

      protected GetFieldMappingRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetFieldMappingRequest.Builder>

    • build

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