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
Adds new fields to an existing data stream or index. You can also use this
API to change the search settings of existing fields. For data streams, these
changes are applied to all backing indices by default.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutMappingRequest>
Json deserializer forPutMappingRequest
static final Endpoint<PutMappingRequest,
PutMappingResponse, ErrorResponse> Endpoint "indices.put_mapping
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final Boolean
Controls whether dynamic date detection is enabled.final DynamicMapping
dynamic()
Controls whether new fields are added dynamically.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.final List<Map<String,
DynamicTemplate>> Specify dynamic templates for the mapping.final List<ExpandWildcard>
Type of index that wildcard patterns can match.final FieldNamesField
Control whether field names are enabled for the index.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.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.final Time
Period to wait for a connection to the master node.meta()
A mapping type can have custom meta data associated with it.final Boolean
Automatically map strings into numeric data types for all fields.static PutMappingRequest
Mapping for a field.final RoutingField
routing()
Enable making a routing value required on indexed documents.final Map<String,
RuntimeField> runtime()
Mapping of runtime fields for the index.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final SourceField
source()
Control whether the _source field is enabled on the index.final Time
timeout()
Period to wait for a response.final Boolean
Iftrue
, the mappings are applied only to the current write index for the target.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forPutMappingRequest
-
_ENDPOINT
Endpoint "indices.put_mapping
".
-
-
Method Details
-
of
public static PutMappingRequest of(Function<PutMappingRequest.Builder, ObjectBuilder<PutMappingRequest>> fn) -
fieldNames
Control whether field names are enabled for the index.API name:
_field_names
-
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
Enable making a routing value required on indexed documents.API name:
_routing
-
source
Control whether the _source field is enabled on the index.API name:
_source
-
allowNoIndices
Iffalse
, 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
Controls whether dynamic date detection is enabled.API name:
date_detection
-
dynamic
Controls whether new fields are added dynamically.API name:
dynamic
-
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
Specify dynamic templates for the mapping.API name:
dynamic_templates
-
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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
-
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
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
Automatically map strings into numeric data types for all fields.API name:
numeric_detection
-
properties
Mapping for a field. For new fields, this mapping can include:- Field name
- Field data type
- Mapping parameters
API name:
properties
-
runtime
Mapping of runtime fields for the index.API name:
runtime
-
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
Iftrue
, the mappings are applied only to the current write index for the target.API name:
write_index_only
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutMappingRequestDeserializer
protected static void setupPutMappingRequestDeserializer(ObjectDeserializer<PutMappingRequest.Builder> op)
-