[[reference-indices-get_field_mapping]] //////// =========================================================================================================================== || || || || || || || ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ || || ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ || || ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ || || ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ || || ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ || || ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ || || || || || || This file is autogenerated, DO NOT send pull requests that changes this file directly. || || You should update the script that does the generation, which can be found in: || || https://github.com/elastic/elastic-client-generator-js || || || || You can run the script with the following command: || || npm run elasticsearch -- --version || || || || || || || =========================================================================================================================== //////// [discrete] === client.indices.getFieldMapping Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. {ref}/indices-get-field-mapping.html[{es} documentation] [discrete] ==== Function signature [source,ts] ---- (IndicesGetFieldMappingRequest, options?): Promise ---- [discrete] ===== `IndicesGetFieldMappingRequest` [source,ts] ---- interface IndicesGetFieldMappingRequest extends <> { fields: <> index?: <> allow_no_indices?: boolean expand_wildcards?: <> ignore_unavailable?: boolean include_defaults?: boolean local?: boolean } ---- [discrete] ===== `IndicesGetFieldMappingResponse` [source,ts] ---- type IndicesGetFieldMappingResponse = Record<<>, IndicesGetFieldMappingTypeFieldMappings> ----