Package org.opensearch.client.opensearch.indices

Class GetMappingRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public GetMappingRequest.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<GetMappingRequest.Builder,GetMappingRequest>
      Returns:
      a new builder instance.

    • self

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

    • allowNoIndices

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

      API name: allow_no_indices

    • clusterManagerTimeout

      @Nonnull public final GetMappingRequest.Builder clusterManagerTimeout(@Nullable Time value)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • clusterManagerTimeout

      @Nonnull public final GetMappingRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • index

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

    • local

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

      API name: local

    • masterTimeout

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

      API name: master_timeout

    • masterTimeout

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

      API name: master_timeout

    • build

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