Package co.elastic.clients.elasticsearch.indices

Class GetMappingRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final GetMappingRequest.Builder allowNoIndices(@Nullable Boolean value)
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

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

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

    • ignoreUnavailable

      public final GetMappingRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

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

      @Deprecated public final GetMappingRequest.Builder local(@Nullable Boolean value)
      Deprecated.
      7.8.0 This parameter is a no-op and field mappings are always retrieved locally.
      If true, the request retrieves information from the local node only.

      API name: local

    • masterTimeout

      public final GetMappingRequest.Builder masterTimeout(@Nullable Time value)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • masterTimeout

      public final GetMappingRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • self

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

    • build

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