Package co.elastic.clients.elasticsearch.indices

Class GetMappingRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.indices.GetMappingRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetMappingRequest>
Enclosing class:
GetMappingRequest
public static class GetMappingRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetMappingRequest>
Builder for GetMappingRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final GetMappingRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • expandWildcards

      public final GetMappingRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final GetMappingRequest.Builder expandWildcards​(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final GetMappingRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • includeTypeName

      public final GetMappingRequest.Builder includeTypeName​(@Nullable java.lang.Boolean value)
      Whether to add the type name to the response (default: false)

      API name: include_type_name

    • index

      public final GetMappingRequest.Builder index​(java.util.List<java.lang.String> list)
      A comma-separated list of index names

      API name: index

      Adds all elements of list to index.

    • index

      public final GetMappingRequest.Builder index​(java.lang.String value, java.lang.String... values)
      A comma-separated list of index names

      API name: index

      Adds one or more values to index.

    • local

      public final GetMappingRequest.Builder local​(@Nullable java.lang.Boolean value)
      Return local information, do not retrieve the state from master node (default: false)

      API name: local

    • masterTimeout

      public final GetMappingRequest.Builder masterTimeout​(@Nullable Time value)
      Specify timeout for connection to master

      API name: master_timeout

    • masterTimeout

      public final GetMappingRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Specify timeout for connection to master

      API name: master_timeout

    • type

      public final GetMappingRequest.Builder type​(java.util.List<java.lang.String> list)
      A comma-separated list of document types

      API name: type

      Adds all elements of list to type.

    • type

      public final GetMappingRequest.Builder type​(java.lang.String value, java.lang.String... values)
      A comma-separated list of document types

      API name: type

      Adds one or more values to type.

    • build

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