Simulate data ingestion | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Path parameters

• The index to simulate ingesting into. This value can be overridden by specifying an index on each document. If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.

Query parameters

• The pipeline to use as the default pipeline. This value can be used to override the default pipeline of the index.

application/json

Body Required

• docs
  array[object] Required
  Sample documents to test in the pipeline.
  Hide docs attributes Show docs attributes object
  • JSON body for the document.
• component_template_substitutions
  object
  A map of component template names to substitute component template definition objects.
  Hide component_template_substitutions attribute Show component_template_substitutions attribute object
  • Hide * attributes Show * attributes object
    * Hide template attributes Show template attributes object
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
    * Hide settings attribute Show settings attribute object
    * Hide mappings attributes Show mappings attributes object
    * Hide all_field attributes Show all_field attributes object
    * omit_norms
    boolean Required
    * search_analyzer
    string Required
    * similarity
    string Required
    * store_term_vector_offsets
    boolean Required
    * store_term_vector_payloads
    boolean Required
    * store_term_vector_positions
    boolean Required
    * store_term_vectors
    boolean Required
    * Values are strict, runtime, true, or false.
    * dynamic_date_formats
    array[string]
    * dynamic_templates
    array[object]
    * Hide _field_names attribute Show _field_names attribute object
    * Hide index_field attribute Show index_field attribute object
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
    * numeric_detection
    boolean
    * Hide _routing attribute Show _routing attribute object
    * required
    boolean Required
    * Hide _size attribute Show _size attribute object
    * Hide _source attributes Show _source attributes object
    * compress_threshold
    string
    * Values are disabled, stored, or synthetic.
    * Hide runtime attribute Show runtime attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * For type composite
    * fetch_fields
    array[object]
    For type lookup
    * A custom format for date type runtime fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
    * Values are true or false.
    * _data_stream_timestamp
    object
    Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object
    * Hide aliases attribute Show aliases attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
    External documentation
    * Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
    * If true, the index is the write index for the alias.
    * Value used to route indexing and search operations to a specific shard.
    * Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
    * is_hidden
    boolean Generally available; Added in 7.16.0
    If true, the alias is hidden. All indices for the alias must have the same is_hidden value.
    * Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.
    Hide lifecycle attributes Show lifecycle attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide downsampling attribute Show downsampling attribute object
    * rounds
    array[object] Required
    The list of downsampling rounds to execute as part of this downsampling configuration
    * If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
    * Hide rollover attributes Show rollover attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * min_size
    * max_size
    * min_primary_shard_size
    * max_primary_shard_size
    * min_primary_shard_docs
    number
    * max_primary_shard_docs
    number
    * #### data_stream_options object | string | null
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
• index_template_substitutions
  object
  A map of index template names to substitute index template definition objects.
  Hide index_template_substitutions attribute Show index_template_substitutions attribute object
  • Hide * attributes Show * attributes object
    * index_patterns
    string | array[string] Required
    * composed_of
    array[string] Required
    An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
    * Hide template attributes Show template attributes object
    * Aliases to add. If the index template includes a data_stream object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the index_routing, routing, and search_routing options.
    Hide aliases attribute Show aliases attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
    External documentation
    * If true, the alias is hidden. All indices for the alias must have the same is_hidden value.
    * If true, the index is the write index for the alias.
    * Hide mappings attributes Show mappings attributes object
    * Hide all_field attributes Show all_field attributes object
    * omit_norms
    boolean Required
    * search_analyzer
    string Required
    * similarity
    string Required
    * store_term_vector_offsets
    boolean Required
    * store_term_vector_payloads
    boolean Required
    * store_term_vector_positions
    boolean Required
    * store_term_vectors
    boolean Required
    * Values are strict, runtime, true, or false.
    * dynamic_date_formats
    array[string]
    * dynamic_templates
    array[object]
    * Hide _field_names attribute Show _field_names attribute object
    * Hide index_field attribute Show index_field attribute object
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
    * numeric_detection
    boolean
    * Hide _routing attribute Show _routing attribute object
    * required
    boolean Required
    * Hide _size attribute Show _size attribute object
    * Hide _source attributes Show _source attributes object
    * compress_threshold
    string
    * Values are disabled, stored, or synthetic.
    * Hide runtime attribute Show runtime attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * For type composite
    * fetch_fields
    array[object]
    For type lookup
    * A custom format for date type runtime fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
    * Values are true or false.
    * _data_stream_timestamp
    object
    Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object
    * Index settings
    * Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.
    Hide lifecycle attributes Show lifecycle attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide downsampling attribute Show downsampling attribute object
    * rounds
    array[object] Required
    The list of downsampling rounds to execute as part of this downsampling configuration
    * If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
    * Hide rollover attributes Show rollover attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * min_size
    * max_size
    * min_primary_shard_size
    * max_primary_shard_size
    * min_primary_shard_docs
    number
    * max_primary_shard_docs
    number
    * #### data_stream_options object | string | null
    * Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
    * allow_auto_create
    boolean
    * Hide data_stream attributes Show data_stream attributes object
    * If true, the data stream is hidden.
    * allow_custom_routing
    boolean
    If true, the data stream supports custom routing.
    * deprecated
    boolean Generally available; Added in 8.12.0
    Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.
    * ignore_missing_component_templates
    string | array[string]
• Hide mapping_addition attributes Show mapping_addition attributes object
  • Hide all_field attributes Show all_field attributes object
    * omit_norms
    boolean Required
    * search_analyzer
    string Required
    * similarity
    string Required
    * store_term_vector_offsets
    boolean Required
    * store_term_vector_payloads
    boolean Required
    * store_term_vector_positions
    boolean Required
    * store_term_vectors
    boolean Required
  • Values are strict, runtime, true, or false.
  • dynamic_date_formats
    array[string]
  • dynamic_templates
    array[object]
  • Hide _field_names attribute Show _field_names attribute object
  • Hide index_field attribute Show index_field attribute object
  • Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
  • numeric_detection
    boolean
  • Hide _routing attribute Show _routing attribute object
    * required
    boolean Required
  • Hide _size attribute Show _size attribute object
  • Hide _source attributes Show _source attributes object
    * compress_threshold
    string
    * Values are disabled, stored, or synthetic.
  • Hide runtime attribute Show runtime attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * For type composite
    Hide fields attribute Show fields attribute object
    * *
    object Additional properties
    Hide * attribute Show * attribute object
    * Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
    * fetch_fields
    array[object]
    For type lookup
    Hide fetch_fields attributes Show fetch_fields attributes object
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * A custom format for date type runtime fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide script attributes Show script attributes object
    * #### source string | object
    * Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
    Hide params attribute Show params attribute object
    * *
    object Additional properties
    * #### lang string
    Values are painless, expression, mustache, or java.
    * Hide options attribute Show options attribute object
    * *
    string Additional properties
    * Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
  • Values are true or false.
  • _data_stream_timestamp
    object
    Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object
• pipeline_substitutions
  object
  Pipelines to test. If you don’t specify the pipeline request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter.
  Hide pipeline_substitutions attribute Show pipeline_substitutions attribute object
  • *
    object Additional properties
    Hide * attributes Show * attributes object
    * Description of the ingest pipeline.
    * Processors to run immediately after a processor failure.
    Hide on_failure attributes Show on_failure attributes object
    * Hide append attributes Show append attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * value
    * If false, the processor does not append values already present in the field.
    * Hide attachment attributes Show attachment attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * The number of chars being used for extraction to prevent huge fields. Use -1 for no limit.
    * indexed_chars_field
    string
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Array of properties to select to be stored. Can be content, title, name, author, keywords, date, content_type, content_length, language.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, the binary field will be removed from the document
    * Field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.
    * Hide bytes attributes Show bytes attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide circle attributes Show circle attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * error_distance
    number Required
    The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape).
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * shape_type
    string Required
    Values are geo_shape or shape.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide community_id attributes Show community_id attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
    * If true and any required fields are missing, the processor quietly exits without modifying the document.
    * Hide convert attributes Show convert attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Values are integer, long, double, float, boolean, ip, string, or auto.
    * Hide csv attributes Show csv attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes ("").
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Quote used in CSV, has to be single character string.
    * Separator used in CSV, has to be single character string.
    * target_fields
    string | array[string] Required
    * Trim whitespaces in unquoted fields.
    * Hide date attributes Show date attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * formats
    array[string] Required
    An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
    * The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * The timezone to use when parsing the date. Supports template snippets.
    * The format to use when writing the date to target_field. Must be a valid java time pattern.
    * Hide date_index_name attributes Show date_index_name attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * date_formats
    array[string]
    An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
    * date_rounding
    string Required
    How to round the date when formatting the date into the index name. Valid values are:y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). Supports template snippets.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets.
    * A prefix of the index name to be prepended before the printed date. Supports template snippets.
    * The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.
    * The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.
    * Hide dissect attributes Show dissect attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The character(s) that separate the appended fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * The pattern to apply to the field.
    * Hide dot_expander attributes Show dot_expander attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Controls the behavior when there is already an existing nested object that conflicts with the expanded field. When false, the processor will merge conflicts by combining the old and the new values into an array. When true, the value from the expanded field will overwrite the existing value.
    * The field that contains the field to expand. Only required if the field to expand is part another object field, because the field option can only understand leaf fields.
    * Hide drop attributes Show drop attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Hide enrich attributes Show enrich attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * The maximum number of matched documents to include under the configured target field. The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128.
    * If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
    * policy_name
    string Required
    The name of the enrich policy to use.
    * Values are intersects, disjoint, within, or contains.
    * target_field
    string Required
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide fail attributes Show fail attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The error message thrown by the processor. Supports template snippets.
    * Hide fingerprint attributes Show fingerprint attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * fields
    string | array[string] Required
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Salt value for the hash function.
    * Values are MD5, SHA-1, SHA-256, SHA-512, or MurmurHash3.
    * If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    * Hide foreach attributes Show foreach attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, the processor silently exits without changing the document if the field is null or missing.
    * processor
    object Required
    * Hide ip_location attributes Show ip_location attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, only the first found IP location data will be returned, even if the field contains an array.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Controls what properties are added to the target_field based on the IP location lookup.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * download_database_on_pipeline_creation
    boolean
    If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
    * Hide geo_grid attributes Show geo_grid attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The field to interpret as a geo-tile.= The field format is determined by the tile_type.
    * tile_type
    string Required
    Values are geotile, geohex, or geohash.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * non_children_field
    string
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Values are geojson or wkt.
    * Hide geoip attributes Show geoip attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, only the first found geoip data will be returned, even if the field contains an array.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Controls what properties are added to the target_field based on the geoip lookup.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * download_database_on_pipeline_creation
    boolean
    If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
    * Hide grok attributes Show grok attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Must be disabled or v1. If v1, the processor uses patterns with Elastic Common Schema (ECS) field names.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * pattern_definitions
    object
    A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition.
    * patterns
    array[string] Required
    An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.
    * When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched.
    * Hide gsub attributes Show gsub attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * The pattern to be replaced.
    * replacement
    string Required
    The string to replace the matching patterns with.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide html_strip attributes Show html_strip attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document,
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide inference attributes Show inference attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration.
    * input_output
    * If true and any of the input fields defined in input_ouput are missing then those missing fields are quietly ignored, otherwise a missing field causes a failure. Only applies when using input_output configurations to explicitly list the input fields.
    * Hide join attributes Show join attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * separator
    string Required
    The separator character.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide json attributes Show json attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Flag that forces the parsed JSON to be added at the top level of the document.target_field must not be set when this option is chosen.
    * add_to_root_conflict_strategy
    string
    Values are replace or merge.
    * allow_duplicate_keys
    boolean
    When set to true, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide kv attributes Show kv attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * exclude_keys
    array[string]
    List of keys to exclude from document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * field_split
    string Required
    Regex pattern to use for splitting key-value pairs.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * include_keys
    array[string]
    List of keys to filter and insert into document. Defaults to including all keys.
    * Prefix to be added to extracted keys.
    * If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * String of characters to trim from extracted keys.
    * String of characters to trim from extracted values.
    * value_split
    string Required
    Regex pattern to use for splitting the key from the value within a key-value pair.
    * Hide lowercase attributes Show lowercase attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide network_direction attributes Show network_direction attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * internal_networks
    array[string]
    List of internal networks. Supports IPv4 and IPv6 addresses and ranges in CIDR notation. Also supports the named ranges listed below. These may be constructed with template snippets. Must specify only one of internal_networks or internal_networks_field.
    * internal_networks_field
    string
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and any required fields are missing, the processor quietly exits without modifying the document.
    * Hide pipeline attributes Show pipeline attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * ignore_missing_pipeline
    boolean
    Whether to ignore missing pipelines instead of failing.
    * Hide redact attributes Show redact attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * patterns
    array[string] Required
    A list of grok expressions to match and redact named captures with
    * pattern_definitions
    object
    * Start a redacted section with this token
    * End a redacted section with this token
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * skip_if_unlicensed
    boolean
    If true and the current license does not support running redact processors, then the processor quietly exits without modifying the document
    * trace_redact
    boolean Generally available; Added in 8.16.0
    If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted
    * Hide registered_domain attributes Show registered_domain attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and any required fields are missing, the processor quietly exits without modifying the document.
    * Hide remove attributes Show remove attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * field
    string | array[string] Required
    * keep
    string | array[string]
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Hide rename attributes Show rename attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * target_field
    string Required
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide reroute attributes Show reroute attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * A static value for the target. Can’t be set when the dataset or namespace option is set.
    * dataset
    * namespace
    * Hide script attributes Show script attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * lang
    * Object containing parameters for the script.
    * source
    * Hide set attributes Show set attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * ignore_empty_value
    boolean
    If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document.
    * The media type for encoding value. Applies only when value is a template snippet. Must be one of application/json, text/plain, or application/x-www-form-urlencoded.
    * If true processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
    * The value to be set for the field. Supports template snippets. May specify only one of value or copy_from.
    * Hide set_security_user attributes Show set_security_user attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Controls what user related properties are added to the field.
    * Hide sort attributes Show sort attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide split attributes Show split attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * preserve_trailing
    boolean
    Preserves empty trailing fields, if any.
    * separator
    string Required
    A regex which matches the separator, for example, , or \s+.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide terminate attributes Show terminate attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Hide trim attributes Show trim attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide uppercase attributes Show uppercase attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide urldecode attributes Show urldecode attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide uri_parts attributes Show uri_parts attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * If true, the processor copies the unparsed URI to <target_field>.original.
    * remove_if_successful
    boolean
    If true, the processor removes the field after parsing the URI string. If parsing fails, the processor does not remove the field.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide user_agent attributes Show user_agent attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Controls what properties are added to target_field.
    Values are name, os, device, original, or version.
    * extract_device_type
    boolean Beta; Added in 8.9.0
    Extracts device type from the user agent string on a best-effort basis.
    * Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
    Hide processors attributes Show processors attributes object
    * Hide append attributes Show append attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * value
    * If false, the processor does not append values already present in the field.
    * Hide attachment attributes Show attachment attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * The number of chars being used for extraction to prevent huge fields. Use -1 for no limit.
    * indexed_chars_field
    string
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Array of properties to select to be stored. Can be content, title, name, author, keywords, date, content_type, content_length, language.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, the binary field will be removed from the document
    * Field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.
    * Hide bytes attributes Show bytes attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide circle attributes Show circle attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * error_distance
    number Required
    The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape).
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * shape_type
    string Required
    Values are geo_shape or shape.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide community_id attributes Show community_id attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
    * If true and any required fields are missing, the processor quietly exits without modifying the document.
    * Hide convert attributes Show convert attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Values are integer, long, double, float, boolean, ip, string, or auto.
    * Hide csv attributes Show csv attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes ("").
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Quote used in CSV, has to be single character string.
    * Separator used in CSV, has to be single character string.
    * target_fields
    string | array[string] Required
    * Trim whitespaces in unquoted fields.
    * Hide date attributes Show date attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * formats
    array[string] Required
    An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
    * The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * The timezone to use when parsing the date. Supports template snippets.
    * The format to use when writing the date to target_field. Must be a valid java time pattern.
    * Hide date_index_name attributes Show date_index_name attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * date_formats
    array[string]
    An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
    * date_rounding
    string Required
    How to round the date when formatting the date into the index name. Valid values are:y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). Supports template snippets.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets.
    * A prefix of the index name to be prepended before the printed date. Supports template snippets.
    * The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.
    * The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.
    * Hide dissect attributes Show dissect attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The character(s) that separate the appended fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * The pattern to apply to the field.
    * Hide dot_expander attributes Show dot_expander attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Controls the behavior when there is already an existing nested object that conflicts with the expanded field. When false, the processor will merge conflicts by combining the old and the new values into an array. When true, the value from the expanded field will overwrite the existing value.
    * The field that contains the field to expand. Only required if the field to expand is part another object field, because the field option can only understand leaf fields.
    * Hide drop attributes Show drop attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Hide enrich attributes Show enrich attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * The maximum number of matched documents to include under the configured target field. The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128.
    * If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
    * policy_name
    string Required
    The name of the enrich policy to use.
    * Values are intersects, disjoint, within, or contains.
    * target_field
    string Required
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide fail attributes Show fail attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The error message thrown by the processor. Supports template snippets.
    * Hide fingerprint attributes Show fingerprint attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * fields
    string | array[string] Required
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Salt value for the hash function.
    * Values are MD5, SHA-1, SHA-256, SHA-512, or MurmurHash3.
    * If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    * Hide foreach attributes Show foreach attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, the processor silently exits without changing the document if the field is null or missing.
    * processor
    object Required
    * Hide ip_location attributes Show ip_location attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, only the first found IP location data will be returned, even if the field contains an array.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Controls what properties are added to the target_field based on the IP location lookup.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * download_database_on_pipeline_creation
    boolean
    If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
    * Hide geo_grid attributes Show geo_grid attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The field to interpret as a geo-tile.= The field format is determined by the tile_type.
    * tile_type
    string Required
    Values are geotile, geohex, or geohash.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * non_children_field
    string
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Values are geojson or wkt.
    * Hide geoip attributes Show geoip attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true, only the first found geoip data will be returned, even if the field contains an array.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Controls what properties are added to the target_field based on the geoip lookup.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * download_database_on_pipeline_creation
    boolean
    If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
    * Hide grok attributes Show grok attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Must be disabled or v1. If v1, the processor uses patterns with Elastic Common Schema (ECS) field names.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * pattern_definitions
    object
    A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition.
    * patterns
    array[string] Required
    An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.
    * When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched.
    * Hide gsub attributes Show gsub attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * The pattern to be replaced.
    * replacement
    string Required
    The string to replace the matching patterns with.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide html_strip attributes Show html_strip attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document,
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide inference attributes Show inference attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration.
    * input_output
    * If true and any of the input fields defined in input_ouput are missing then those missing fields are quietly ignored, otherwise a missing field causes a failure. Only applies when using input_output configurations to explicitly list the input fields.
    * Hide join attributes Show join attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * separator
    string Required
    The separator character.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide json attributes Show json attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Flag that forces the parsed JSON to be added at the top level of the document.target_field must not be set when this option is chosen.
    * add_to_root_conflict_strategy
    string
    Values are replace or merge.
    * allow_duplicate_keys
    boolean
    When set to true, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide kv attributes Show kv attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * exclude_keys
    array[string]
    List of keys to exclude from document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * field_split
    string Required
    Regex pattern to use for splitting key-value pairs.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * include_keys
    array[string]
    List of keys to filter and insert into document. Defaults to including all keys.
    * Prefix to be added to extracted keys.
    * If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * String of characters to trim from extracted keys.
    * String of characters to trim from extracted values.
    * value_split
    string Required
    Regex pattern to use for splitting the key from the value within a key-value pair.
    * Hide lowercase attributes Show lowercase attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide network_direction attributes Show network_direction attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * internal_networks
    array[string]
    List of internal networks. Supports IPv4 and IPv6 addresses and ranges in CIDR notation. Also supports the named ranges listed below. These may be constructed with template snippets. Must specify only one of internal_networks or internal_networks_field.
    * internal_networks_field
    string
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and any required fields are missing, the processor quietly exits without modifying the document.
    * Hide pipeline attributes Show pipeline attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * ignore_missing_pipeline
    boolean
    Whether to ignore missing pipelines instead of failing.
    * Hide redact attributes Show redact attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * patterns
    array[string] Required
    A list of grok expressions to match and redact named captures with
    * pattern_definitions
    object
    * Start a redacted section with this token
    * End a redacted section with this token
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * skip_if_unlicensed
    boolean
    If true and the current license does not support running redact processors, then the processor quietly exits without modifying the document
    * trace_redact
    boolean Generally available; Added in 8.16.0
    If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted
    * Hide registered_domain attributes Show registered_domain attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and any required fields are missing, the processor quietly exits without modifying the document.
    * Hide remove attributes Show remove attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * field
    string | array[string] Required
    * keep
    string | array[string]
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Hide rename attributes Show rename attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * target_field
    string Required
    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide reroute attributes Show reroute attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * A static value for the target. Can’t be set when the dataset or namespace option is set.
    * dataset
    * namespace
    * Hide script attributes Show script attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * lang
    * Object containing parameters for the script.
    * source
    * Hide set attributes Show set attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * ignore_empty_value
    boolean
    If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document.
    * The media type for encoding value. Applies only when value is a template snippet. Must be one of application/json, text/plain, or application/x-www-form-urlencoded.
    * If true processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
    * The value to be set for the field. Supports template snippets. May specify only one of value or copy_from.
    * Hide set_security_user attributes Show set_security_user attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Controls what user related properties are added to the field.
    * Hide sort attributes Show sort attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide split attributes Show split attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * preserve_trailing
    boolean
    Preserves empty trailing fields, if any.
    * separator
    string Required
    A regex which matches the separator, for example, , or \s+.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide terminate attributes Show terminate attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Hide trim attributes Show trim attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide uppercase attributes Show uppercase attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide urldecode attributes Show urldecode attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist or is null, the processor quietly exits without modifying the document.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide uri_parts attributes Show uri_parts attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * If true, the processor copies the unparsed URI to <target_field>.original.
    * remove_if_successful
    boolean
    If true, the processor removes the field after parsing the URI string. If parsing fails, the processor does not remove the field.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide user_agent attributes Show user_agent attributes object
    * Description of the processor. Useful for describing the purpose of the processor or its configuration.
    * Ignore failures for the processor.
    * Handle failures for the processor.
    * Identifier for the processor. Useful for debugging and metrics.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * If true and field does not exist, the processor quietly exits without modifying the document.
    * The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Controls what properties are added to target_field.
    Values are name, os, device, original, or version.
    * extract_device_type
    boolean Beta; Added in 8.9.0
    Extracts device type from the user agent string on a best-effort basis.
    * Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • docs
    array[object] Required
    Hide docs attribute Show docs attribute object
    * The results of ingest simulation on a single document. The _source of the document contains the results after running all pipelines listed in executed_pipelines on the document. The list of executed pipelines is derived from the pipelines that would be executed if this document had been ingested into _index.
    Hide doc attributes Show doc attributes object
    * JSON body for the document.
    Hide _source attribute Show _source attribute object
    * *
    object Additional properties
    * #### _version number | string Required
    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
    * executed_pipelines
    array[string] Required
    A list of the names of the pipelines executed on this document.
    * ignored_fields
    array[object]
    A list of the fields that would be ignored at the indexing step. For example, a field whose value is larger than the allowed limit would make it through all of the pipelines, but would not be indexed into Elasticsearch.
    Hide ignored_fields attribute Show ignored_fields attribute object
    * *
    string Additional properties
    * Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
    Hide error attributes Show error attributes object
    * The type of error
    * #### reason string | null
    A human-readable explanation of the error, in English.
    * The server stack trace. Present only if the error_trace=true parameter was sent with the request.
    * Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
    * Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
    * Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.