Package co.elastic.clients.elasticsearch.indices

Class PutMappingRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutMappingRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutMappingRequest extends RequestBase implements JsonpSerializable
Update field mappings. Add new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields and add new properties to existing object fields. For data streams, these changes are applied to all backing indices by default.

Add multi-fields to an existing field

Multi-fields let you index the same field in different ways. You can use this API to update the fields mapping parameter and enable multi-fields for an existing field. WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field. You can populate the new multi-field with the update by query API.

Change supported mapping parameters for an existing field

The documentation for each mapping parameter indicates whether you can update it for an existing field using this API. For example, you can use the update mapping API to update the ignore_above parameter.

Change the mapping of an existing field

Except for supported mapping parameters, you can't change the mapping or field type of an existing field. Changing an existing field could invalidate data that's already indexed.

If you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams. If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.

Rename a field

Renaming a field would invalidate data already indexed under the old field name. Instead, add an alias field to create an alternate field name.

See Also:

  • Field Details

  • Method Details

    • of

      public static PutMappingRequest of(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)

    • fieldNames

      @Nullable public final FieldNamesField fieldNames()
      Control whether field names are enabled for the index.

      API name: _field_names

    • meta

      public final Map<String,JsonData> meta()
      A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata.

      API name: _meta

    • routing

      @Nullable public final RoutingField routing()
      Enable making a routing value required on indexed documents.

      API name: _routing

    • source

      @Nullable public final SourceField source()
      Control whether the _source field is enabled on the index.

      API name: _source

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      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

    • dateDetection

      @Nullable public final Boolean dateDetection()
      Controls whether dynamic date detection is enabled.

      API name: date_detection

    • dynamic

      @Nullable public final DynamicMapping dynamic()
      Controls whether new fields are added dynamically.

      API name: dynamic

    • dynamicDateFormats

      public final List<String> dynamicDateFormats()
      If date detection is enabled then new string fields are checked against 'dynamic_date_formats' and if the value matches then a new date field is added instead of string.

      API name: dynamic_date_formats

    • dynamicTemplates

      public final List<NamedValue<DynamicTemplate>> dynamicTemplates()
      Specify dynamic templates for the mapping.

      API name: dynamic_templates

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      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

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • index

      public final List<String> index()
      Required - A comma-separated list of index names the mapping should be added to (supports wildcards); use _all or omit to add the mapping on all indices.

      API name: index

    • masterTimeout

      @Nullable public final Time masterTimeout()
      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

    • numericDetection

      @Nullable public final Boolean numericDetection()
      Automatically map strings into numeric data types for all fields.

      API name: numeric_detection

    • properties

      public final Map<String,Property> properties()
      Mapping for a field. For new fields, this mapping can include:
      • Field name
      • Field data type
      • Mapping parameters

      API name: properties

    • runtime

      public final Map<String,RuntimeField> runtime()
      Mapping of runtime fields for the index.

      API name: runtime

    • timeout

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

      API name: timeout

    • writeIndexOnly

      @Nullable public final Boolean writeIndexOnly()
      If true, the mappings are applied only to the current write index for the target.

      API name: write_index_only

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupPutMappingRequestDeserializer

      protected static void setupPutMappingRequestDeserializer(ObjectDeserializer<PutMappingRequest.Builder> op)