@elastic/schemas 0.4.4 → 0.4.5

package/src/es/json/inference.update.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.update","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be updated.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.","x-found-in":"query"},"inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskType","description":"The type of inference task that the model performs.","x-found-in":"path"}},"required":["inference_id"],"description":"Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.update","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be updated.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.","x-found-in":"query"},"inference_config":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceEndpoint","x-found-in":"body"},"inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskType","description":"The type of inference task that the model performs.","x-found-in":"path"}},"required":["inference_id"],"description":"Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs."}

package/src/es/json/ingest._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ingest._types__DatabaseConfiguration":{"type":"object","properties":{"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download."},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind"},"ipinfo":{"$ref":"./ingest._types.json#/$defs/ingest._types__Ipinfo"}},"required":["name"],"description":"The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured.\nA provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations."},"ingest._types__Maxmind":{"type":"object","properties":{"account_id":{"type":"string"}},"required":["account_id"]},"ingest._types__Ipinfo":{"type":"object","properties":{}},"ingest._types__DatabaseConfigurationFull":{"type":"object","properties":{"web":{"$ref":"./ingest._types.json#/$defs/ingest._types__Web"},"local":{"$ref":"./ingest._types.json#/$defs/ingest._types__Local"},"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download."},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind"},"ipinfo":{"$ref":"./ingest._types.json#/$defs/ingest._types__Ipinfo"}},"required":["name"]},"ingest._types__Web":{"type":"object","properties":{}},"ingest._types__Local":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]},"ingest._types__Pipeline":{"type":"object","properties":{"description":{"type":"string","description":"Description of the ingest pipeline."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors to run immediately after a processor failure."},"processors":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified."},"version":{"type":"number","description":"Version number used by external systems to track ingest pipelines."},"deprecated":{"type":"boolean","description":"Marks this ingest pipeline as deprecated.\nWhen 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."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch."},"created_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the pipeline was created. Only returned if the `human` query parameter is `true`."},"created_date_millis":{"description":"Date and time when the pipeline was created, in milliseconds since the epoch."},"modified_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the pipeline was last modified. Only returned if the `human` query parameter is `true`."},"modified_date_millis":{"description":"Date and time when the pipeline was last modified, in milliseconds since the epoch."},"field_access_pattern":{"$ref":"./ingest._types.json#/$defs/ingest._types__FieldAccessPattern","description":"Controls how processors in this pipeline should read and write data on a document's source."}}},"ingest._types__ProcessorContainer":{"type":"object","properties":{"append":{"$ref":"./ingest._types.json#/$defs/ingest._types__AppendProcessor","description":"Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values."},"attachment":{"$ref":"./ingest._types.json#/$defs/ingest._types__AttachmentProcessor","description":"The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika."},"bytes":{"$ref":"./ingest._types.json#/$defs/ingest._types__BytesProcessor","description":"Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63."},"cef":{"$ref":"./ingest._types.json#/$defs/ingest._types__CefProcessor","description":"Converts a CEF message into a structured format."},"circle":{"$ref":"./ingest._types.json#/$defs/ingest._types__CircleProcessor","description":"Converts circle definitions of shapes to regular polygons which approximate them."},"community_id":{"$ref":"./ingest._types.json#/$defs/ingest._types__CommunityIDProcessor","description":"Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow."},"convert":{"$ref":"./ingest._types.json#/$defs/ingest._types__ConvertProcessor","description":"Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted."},"csv":{"$ref":"./ingest._types.json#/$defs/ingest._types__CsvProcessor","description":"Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped."},"date":{"$ref":"./ingest._types.json#/$defs/ingest._types__DateProcessor","description":"Parses dates from fields, and then uses the date or timestamp as the timestamp for the document."},"date_index_name":{"$ref":"./ingest._types.json#/$defs/ingest._types__DateIndexNameProcessor","description":"The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support."},"dissect":{"$ref":"./ingest._types.json#/$defs/ingest._types__DissectProcessor","description":"Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern."},"dot_expander":{"$ref":"./ingest._types.json#/$defs/ingest._types__DotExpanderProcessor","description":"Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor."},"drop":{"$ref":"./ingest._types.json#/$defs/ingest._types__DropProcessor","description":"Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition."},"enrich":{"$ref":"./ingest._types.json#/$defs/ingest._types__EnrichProcessor","description":"The `enrich` processor can enrich documents with data from another index."},"fail":{"$ref":"./ingest._types.json#/$defs/ingest._types__FailProcessor","description":"Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester."},"fingerprint":{"$ref":"./ingest._types.json#/$defs/ingest._types__FingerprintProcessor","description":"Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting."},"foreach":{"$ref":"./ingest._types.json#/$defs/ingest._types__ForeachProcessor","description":"Runs an ingest processor on each element of an array or object."},"ip_location":{"$ref":"./ingest._types.json#/$defs/ingest._types__IpLocationProcessor","description":"Currently an undocumented alias for GeoIP Processor."},"geo_grid":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoGridProcessor","description":"Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields."},"geoip":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoIpProcessor","description":"The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address."},"grok":{"$ref":"./ingest._types.json#/$defs/ingest._types__GrokProcessor","description":"Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused."},"gsub":{"$ref":"./ingest._types.json#/$defs/ingest._types__GsubProcessor","description":"Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception."},"html_strip":{"$ref":"./ingest._types.json#/$defs/ingest._types__HtmlStripProcessor","description":"Removes HTML tags from the field.\nIf the field is an array of strings, HTML tags will be removed from all members of the array."},"inference":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceProcessor","description":"Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline."},"join":{"$ref":"./ingest._types.json#/$defs/ingest._types__JoinProcessor","description":"Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array."},"json":{"$ref":"./ingest._types.json#/$defs/ingest._types__JsonProcessor","description":"Parses a string containing JSON data into a structured object, string, or other value."},"kv":{"$ref":"./ingest._types.json#/$defs/ingest._types__KeyValueProcessor","description":"This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety."},"lowercase":{"$ref":"./ingest._types.json#/$defs/ingest._types__LowercaseProcessor","description":"Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted."},"network_direction":{"$ref":"./ingest._types.json#/$defs/ingest._types__NetworkDirectionProcessor","description":"Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks."},"pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineProcessor","description":"Executes another pipeline."},"redact":{"$ref":"./ingest._types.json#/$defs/ingest._types__RedactProcessor","description":"The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `<EMAIL>` where an email address is matched or simply replace all matches with the text `<REDACTED>` if preferred."},"registered_domain":{"$ref":"./ingest._types.json#/$defs/ingest._types__RegisteredDomainProcessor","description":"Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List."},"remove":{"$ref":"./ingest._types.json#/$defs/ingest._types__RemoveProcessor","description":"Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown."},"rename":{"$ref":"./ingest._types.json#/$defs/ingest._types__RenameProcessor","description":"Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown."},"reroute":{"$ref":"./ingest._types.json#/$defs/ingest._types__RerouteProcessor","description":"Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme."},"script":{"$ref":"./ingest._types.json#/$defs/ingest._types__ScriptProcessor","description":"Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context."},"set":{"$ref":"./ingest._types.json#/$defs/ingest._types__SetProcessor","description":"Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one."},"set_security_user":{"$ref":"./ingest._types.json#/$defs/ingest._types__SetSecurityUserProcessor","description":"Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest."},"sort":{"$ref":"./ingest._types.json#/$defs/ingest._types__SortProcessor","description":"Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array."},"split":{"$ref":"./ingest._types.json#/$defs/ingest._types__SplitProcessor","description":"Splits a field into an array using a separator character.\nOnly works on string fields."},"terminate":{"$ref":"./ingest._types.json#/$defs/ingest._types__TerminateProcessor","description":"Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option."},"trim":{"$ref":"./ingest._types.json#/$defs/ingest._types__TrimProcessor","description":"Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace."},"uppercase":{"$ref":"./ingest._types.json#/$defs/ingest._types__UppercaseProcessor","description":"Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted."},"urldecode":{"$ref":"./ingest._types.json#/$defs/ingest._types__UrlDecodeProcessor","description":"URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded."},"uri_parts":{"$ref":"./ingest._types.json#/$defs/ingest._types__UriPartsProcessor","description":"Parses a Uniform Resource Identifier (URI) string and extracts its components as an object.\nThis URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password."},"user_agent":{"$ref":"./ingest._types.json#/$defs/ingest._types__UserAgentProcessor","description":"The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field."}}},"ingest._types__AppendProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be appended to.\nSupports template snippets."},"value":{"oneOf":[{},{"type":"array","items":{}}],"description":"The value to be appended. Supports template snippets. May specify only one of `value` or `copy_from`."},"media_type":{"type":"string","description":"The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`."},"copy_from":{"type":"string","description":"The origin field which will be appended to `field`, cannot set `value` simultaneously."},"allow_duplicates":{"type":"boolean","description":"If `false`, the processor does not append values already present in the field."},"ignore_empty_values":{"type":"boolean","description":"If `true`, the processor will skip empty values from the source (e.g. empty strings, and null values),\nrather than appending them to the field."}},"required":["field"]},"ingest._types__AttachmentProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to get the base64 encoded field from."},"ignore_missing":{"type":"boolean","description":"If `true` and field does not exist, the processor quietly exits without modifying the document."},"indexed_chars":{"type":"number","description":"The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit."},"indexed_chars_field":{"type":"string","description":"Field name from which you can overwrite the number of chars being used for extraction."},"max_field_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Maximum allowed size of the attachment `field` value in bytes: length of a string (if base64 in JSON,\nchecked before base64 decoding) or byte array length for binary (for example, CBOR).\nIf set to `-1`, there is no per-processor limit.\nThe node setting `ingest.attachment.max_field_size` also applies."},"properties":{"type":"array","items":{"type":"string"},"description":"Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`."},"target_field":{"type":"string","description":"The field that will hold the attachment information."},"remove_binary":{"type":"boolean","description":"If true, the binary field will be removed from the document"},"resource_name":{"type":"string","description":"Field containing the name of the resource to decode.\nIf specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection."}},"required":["field"]},"ingest._types__BytesProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to convert."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__CefProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field containing the CEF message."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the `target_field` is 'cef'"},"ignore_empty_values":{"type":"boolean","description":"If `true` and value is anempty string in extensions, the processor quietly exits without modifying the document."},"timezone":{"type":"string","description":"The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names."}},"required":["field"]},"ingest._types__CircleProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"error_distance":{"type":"number","description":"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`)."},"field":{"type":"string","description":"The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"shape_type":{"$ref":"./ingest._types.json#/$defs/ingest._types__ShapeType","description":"Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`."},"target_field":{"type":"string","description":"The field to assign the polygon shape to\nBy default, the field is updated in-place."}},"required":["error_distance","field","shape_type"]},"ingest._types__ShapeType":{"enum":["geo_shape","shape"]},"ingest._types__CommunityIDProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"source_ip":{"type":"string","description":"Field containing the source IP address."},"source_port":{"type":"string","description":"Field containing the source port."},"destination_ip":{"type":"string","description":"Field containing the destination IP address."},"destination_port":{"type":"string","description":"Field containing the destination port."},"iana_number":{"type":"string","description":"Field containing the IANA number."},"icmp_type":{"type":"string","description":"Field containing the ICMP type."},"icmp_code":{"type":"string","description":"Field containing the ICMP code."},"transport":{"type":"string","description":"Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp"},"target_field":{"type":"string","description":"Output field for the community ID."},"seed":{"type":"number","description":"Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme."},"ignore_missing":{"type":"boolean","description":"If true and any required fields are missing, the processor quietly exits\nwithout modifying the document."}}},"ingest._types__ConvertProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field whose value is to be converted."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the `field` is updated in-place."},"type":{"$ref":"./ingest._types.json#/$defs/ingest._types__ConvertType","description":"The type to convert the existing value to."}},"required":["field","type"]},"ingest._types__ConvertType":{"enum":["integer","long","double","float","boolean","ip","string","auto"]},"ingest._types__CsvProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"empty_value":{"description":"Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`)."},"field":{"type":"string","description":"The field to extract data from."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"quote":{"type":"string","description":"Quote used in CSV, has to be single character string."},"separator":{"type":"string","description":"Separator used in CSV, has to be single character string."},"target_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The array of fields to assign extracted values to."},"trim":{"type":"boolean","description":"Trim whitespaces in unquoted fields."}},"required":["field","target_fields"]},"ingest._types__DateProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to get the date from."},"formats":{"type":"array","items":{"type":"string"},"description":"An array of the expected date formats.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N."},"locale":{"type":"string","description":"The locale to use when parsing the date, relevant when parsing month names or week days.\nSupports template snippets."},"target_field":{"type":"string","description":"The field that will hold the parsed date."},"timezone":{"type":"string","description":"The timezone to use when parsing the date.\nSupports template snippets."},"output_format":{"type":"string","description":"The format to use when writing the date to target_field. Must be a valid\njava time pattern."}},"required":["field","formats"]},"ingest._types__DateIndexNameProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"date_formats":{"type":"array","items":{"type":"string"},"description":"An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N."},"date_rounding":{"type":"string","description":"How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets."},"field":{"type":"string","description":"The field to get the date or timestamp from."},"index_name_format":{"type":"string","description":"The format to be used when printing the parsed date into the index name.\nA valid java time pattern is expected here.\nSupports template snippets."},"index_name_prefix":{"type":"string","description":"A prefix of the index name to be prepended before the printed date.\nSupports template snippets."},"locale":{"type":"string","description":"The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days."},"timezone":{"type":"string","description":"The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names."}},"required":["date_rounding","field"]},"ingest._types__DissectProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"append_separator":{"type":"string","description":"The character(s) that separate the appended fields."},"field":{"type":"string","description":"The field to dissect."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"pattern":{"type":"string","description":"The pattern to apply to the field."}},"required":["field","pattern"]},"ingest._types__DotExpanderProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to expand into an object field.\nIf set to `*`, all top-level fields will be expanded."},"override":{"type":"boolean","description":"Controls the behavior when there is already an existing nested object that conflicts with the expanded field.\nWhen `false`, the processor will merge conflicts by combining the old and the new values into an array.\nWhen `true`, the value from the expanded field will overwrite the existing value."},"path":{"type":"string","description":"The field that contains the field to expand.\nOnly required if the field to expand is part another object field, because the `field` option can only understand leaf fields."}},"required":["field"]},"ingest._types__DropProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."}}},"ingest._types__EnrichProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field in the input document that matches the policies match_field used to retrieve the enrichment data.\nSupports template snippets."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"max_matches":{"type":"number","description":"The maximum number of matched documents to include under the configured target field.\nThe `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.\nIn order to avoid documents getting too large, the maximum allowed value is 128."},"override":{"type":"boolean","description":"If processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched."},"policy_name":{"type":"string","description":"The name of the enrich policy to use."},"shape_relation":{"$ref":"./_types.json#/$defs/_types__GeoShapeRelation","description":"A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.\nThis option is only used for `geo_match` enrich policy types."},"target_field":{"type":"string","description":"Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.\nSupports template snippets."}},"required":["field","policy_name","target_field"]},"ingest._types__FailProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"message":{"type":"string","description":"The error message thrown by the processor.\nSupports template snippets."}},"required":["message"]},"ingest._types__FingerprintProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value."},"target_field":{"type":"string","description":"Output field for the fingerprint."},"salt":{"type":"string","description":"Salt value for the hash function."},"method":{"$ref":"./ingest._types.json#/$defs/ingest._types__FingerprintDigest","description":"The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3."},"ignore_missing":{"type":"boolean","description":"If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document."}},"required":["fields"]},"ingest._types__FingerprintDigest":{"enum":["md5","sha1","sha256","sha512","murmurHash3"]},"ingest._types__ForeachProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing array or object values."},"ignore_missing":{"type":"boolean","description":"If `true`, the processor silently exits without changing the document if the `field` is `null` or missing."},"processor":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer","description":"Ingest processor to run on each element."}},"required":["field","processor"]},"ingest._types__IpLocationProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"database_file":{"type":"string","description":"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."},"field":{"type":"string","description":"The field to get the ip address from for the geographical lookup."},"first_only":{"type":"boolean","description":"If `true`, only the first found IP location data will be returned, even if the field contains an array."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"properties":{"type":"array","items":{"type":"string"},"description":"Controls what properties are added to the `target_field` based on the IP location lookup."},"target_field":{"type":"string","description":"The field that will hold the geographical information looked up from the MaxMind database."},"download_database_on_pipeline_creation":{"type":"boolean","description":"If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index."}},"required":["field"]},"ingest._types__GeoGridProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to interpret as a geo-tile.=\nThe field format is determined by the `tile_type`."},"tile_type":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoGridTileType","description":"Three tile formats are understood: geohash, geotile and geohex."},"target_field":{"type":"string","description":"The field to assign the polygon shape to, by default, the `field` is updated in-place."},"parent_field":{"type":"string","description":"If specified and a parent tile exists, save that tile address to this field."},"children_field":{"type":"string","description":"If specified and children tiles exist, save those tile addresses to this field as an array of strings."},"non_children_field":{"type":"string","description":"If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings."},"precision_field":{"type":"string","description":"If specified, save the tile precision (zoom) as an integer to this field."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"target_format":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoGridTargetFormat","description":"Which format to save the generated polygon in."}},"required":["field","tile_type"]},"ingest._types__GeoGridTileType":{"enum":["geotile","geohex","geohash"]},"ingest._types__GeoGridTargetFormat":{"enum":["geojson","wkt"]},"ingest._types__GeoIpProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"database_file":{"type":"string","description":"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."},"field":{"type":"string","description":"The field to get the ip address from for the geographical lookup."},"first_only":{"type":"boolean","description":"If `true`, only the first found geoip data will be returned, even if the field contains an array."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"properties":{"type":"array","items":{"type":"string"},"description":"Controls what properties are added to the `target_field` based on the geoip lookup."},"target_field":{"type":"string","description":"The field that will hold the geographical information looked up from the MaxMind database."},"download_database_on_pipeline_creation":{"type":"boolean","description":"If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index."}},"required":["field"]},"ingest._types__GrokProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"ecs_compatibility":{"type":"string","description":"Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names."},"field":{"type":"string","description":"The field to use for grok expression parsing."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"pattern_definitions":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.\nPatterns matching existing names will override the pre-existing definition."},"patterns":{"type":"array","items":{"type":"string"},"description":"An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches."},"trace_match":{"type":"boolean","description":"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."},"validate_only":{"type":"boolean","description":"When `true`, the processor does matching but does not extract structured fields"}},"required":["field","patterns"]},"ingest._types__GsubProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to apply the replacement to."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"pattern":{"type":"string","description":"The pattern to be replaced."},"replacement":{"type":"string","description":"The string to replace the matching patterns with."},"target_field":{"type":"string","description":"The field to assign the converted value to\nBy default, the `field` is updated in-place."}},"required":["field","pattern","replacement"]},"ingest._types__HtmlStripProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The string-valued field to remove HTML tags from."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document,"},"target_field":{"type":"string","description":"The field to assign the converted value to\nBy default, the `field` is updated in-place."}},"required":["field"]},"ingest._types__InferenceProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"model_id":{"type":"string","description":"The ID or alias for the trained model, or the ID of the deployment."},"target_field":{"type":"string","description":"Field added to incoming documents to contain results objects."},"field_map":{"type":"object","additionalProperties":{},"description":"Maps the document field names to the known field names of the model.\nThis mapping takes precedence over any default mappings provided in the model configuration."},"inference_config":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceConfig","description":"Contains the inference type and its options."},"input_output":{"oneOf":[{"$ref":"./ingest._types.json#/$defs/ingest._types__InputConfig"},{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__InputConfig"}}],"description":"Input fields for inference and output (destination) fields for the inference results.\nThis option is incompatible with the target_field and field_map options."},"ignore_missing":{"type":"boolean","description":"If true and any of the input fields defined in input_ouput are missing\nthen those missing fields are quietly ignored, otherwise a missing field causes a failure.\nOnly applies when using input_output configurations to explicitly list the input fields."}},"required":["model_id"]},"ingest._types__InferenceConfig":{"type":"object","properties":{"regression":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceConfigRegression","description":"Regression configuration for inference."},"classification":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceConfigClassification","description":"Classification configuration for inference."}}},"ingest._types__InferenceConfigRegression":{"type":"object","properties":{"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."}}},"ingest._types__InferenceConfigClassification":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction."},"top_classes_results_field":{"type":"string","description":"Specifies the field to which the top classes are written."},"prediction_field_type":{"type":"string","description":"Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`."}}},"ingest._types__InputConfig":{"type":"object","properties":{"input_field":{"type":"string"},"output_field":{"type":"string"}},"required":["input_field","output_field"]},"ingest._types__JoinProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing array values to join."},"separator":{"type":"string","description":"The separator character."},"target_field":{"type":"string","description":"The field to assign the joined value to.\nBy default, the field is updated in-place."}},"required":["field","separator"]},"ingest._types__JsonProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"add_to_root":{"type":"boolean","description":"Flag that forces the parsed JSON to be added at the top level of the document.\n`target_field` must not be set when this option is chosen."},"add_to_root_conflict_strategy":{"$ref":"./ingest._types.json#/$defs/ingest._types__JsonProcessorConflictStrategy","description":"When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.\nWhen set to `merge`, conflicting fields will be merged.\nOnly applicable `if add_to_root` is set to true."},"allow_duplicate_keys":{"type":"boolean","description":"When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.\nInstead, the last encountered value for any duplicate key wins."},"field":{"type":"string","description":"The field to be parsed."},"target_field":{"type":"string","description":"The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten."}},"required":["field"]},"ingest._types__JsonProcessorConflictStrategy":{"enum":["replace","merge"]},"ingest._types__KeyValueProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"exclude_keys":{"type":"array","items":{"type":"string"},"description":"List of keys to exclude from document."},"field":{"type":"string","description":"The field to be parsed.\nSupports template snippets."},"field_split":{"type":"string","description":"Regex pattern to use for splitting key-value pairs."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"include_keys":{"type":"array","items":{"type":"string"},"description":"List of keys to filter and insert into document.\nDefaults to including all keys."},"prefix":{"type":"string","description":"Prefix to be added to extracted keys."},"strip_brackets":{"type":"boolean","description":"If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values."},"target_field":{"type":"string","description":"The field to insert the extracted keys into.\nDefaults to the root of the document.\nSupports template snippets."},"trim_key":{"type":"string","description":"String of characters to trim from extracted keys."},"trim_value":{"type":"string","description":"String of characters to trim from extracted values."},"value_split":{"type":"string","description":"Regex pattern to use for splitting the key from the value within a key-value pair."}},"required":["field","field_split","value_split"]},"ingest._types__LowercaseProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to make lowercase."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__NetworkDirectionProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"source_ip":{"type":"string","description":"Field containing the source IP address."},"destination_ip":{"type":"string","description":"Field containing the destination IP address."},"target_field":{"type":"string","description":"Output field for the network direction."},"internal_networks":{"type":"array","items":{"type":"string"},"description":"List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field."},"internal_networks_field":{"type":"string","description":"A field on the given document to read the internal_networks configuration\nfrom."},"ignore_missing":{"type":"boolean","description":"If true and any required fields are missing, the processor quietly exits\nwithout modifying the document."}}},"ingest._types__PipelineProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"name":{"type":"string","description":"The name of the pipeline to execute.\nSupports template snippets."},"ignore_missing_pipeline":{"type":"boolean","description":"Whether to ignore missing pipelines instead of failing."}},"required":["name"]},"ingest._types__RedactProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be redacted"},"patterns":{"type":"array","items":{"type":"string"},"description":"A list of grok expressions to match and redact named captures with"},"pattern_definitions":{"type":"object","additionalProperties":{"type":"string"}},"prefix":{"type":"string","description":"Start a redacted section with this token"},"suffix":{"type":"string","description":"End a redacted section with this token"},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"skip_if_unlicensed":{"type":"boolean","description":"If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document"},"trace_redact":{"type":"boolean","description":"If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted"}},"required":["field","patterns"]},"ingest._types__RegisteredDomainProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing the source FQDN."},"target_field":{"type":"string","description":"Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root."},"ignore_missing":{"type":"boolean","description":"If true and any required fields are missing, the processor quietly exits\nwithout modifying the document."}},"required":["field"]},"ingest._types__RemoveProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Fields to be removed. Supports template snippets."},"keep":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Fields to be kept. When set, all fields other than those specified are removed."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."}},"required":["field"]},"ingest._types__RenameProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be renamed.\nSupports template snippets."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The new name of the field.\nSupports template snippets."}},"required":["field","target_field"]},"ingest._types__RerouteProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"destination":{"type":"string","description":"A static value for the target. Can’t be set when the dataset or namespace option is set."},"dataset":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Field references or a static value for the dataset part of the data stream name.\nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.\nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}"},"namespace":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}"}}},"ingest._types__ScriptProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"id":{"type":"string","description":"ID of a stored script.\nIf no `source` is specified, this parameter is required."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Script language."},"params":{"type":"object","additionalProperties":{},"description":"Object containing parameters for the script."},"source":{"$ref":"./_types.json#/$defs/_types__ScriptSource","description":"Inline script.\nIf no `id` is specified, this parameter is required."}}},"ingest._types__SetProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"copy_from":{"type":"string","description":"The origin field which will be copied to `field`, cannot set `value` simultaneously.\nSupported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc."},"field":{"type":"string","description":"The field to insert, upsert, or update.\nSupports template snippets."},"ignore_empty_value":{"type":"boolean","description":"If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document."},"media_type":{"type":"string","description":"The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`."},"override":{"type":"boolean","description":"If `true` processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched."},"value":{"description":"The value to be set for the field.\nSupports template snippets.\nMay specify only one of `value` or `copy_from`."}},"required":["field"]},"ingest._types__SetSecurityUserProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to store the user information into."},"properties":{"type":"array","items":{"type":"string"},"description":"Controls what user related properties are added to the field."}},"required":["field"]},"ingest._types__SortProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be sorted."},"order":{"$ref":"./_types.json#/$defs/_types__SortOrder","description":"The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`."},"target_field":{"type":"string","description":"The field to assign the sorted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__SplitProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to split."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"preserve_trailing":{"type":"boolean","description":"Preserves empty trailing fields, if any."},"separator":{"type":"string","description":"A regex which matches the separator, for example, `,` or `\\s+`."},"target_field":{"type":"string","description":"The field to assign the split value to.\nBy default, the field is updated in-place."}},"required":["field","separator"]},"ingest._types__TerminateProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."}}},"ingest._types__TrimProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The string-valued field to trim whitespace from."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the trimmed value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__UppercaseProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to make uppercase."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__UrlDecodeProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to decode."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__UriPartsProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing the URI string."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"keep_original":{"type":"boolean","description":"If `true`, the processor copies the unparsed URI to `<target_field>.original`."},"remove_if_successful":{"type":"boolean","description":"If `true`, the processor removes the `field` after parsing the URI string.\nIf parsing fails, the processor does not remove the `field`."},"target_field":{"type":"string","description":"Output field for the URI object."}},"required":["field"]},"ingest._types__UserAgentProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field containing the user agent string."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"regex_file":{"type":"string","description":"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."},"target_field":{"type":"string","description":"The field that will be filled with the user agent details."},"properties":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__UserAgentProperty"},"description":"Controls what properties are added to `target_field`."},"extract_device_type":{"type":"boolean","description":"Extracts device type from the user agent string on a best-effort basis."}},"required":["field"]},"ingest._types__UserAgentProperty":{"enum":["name","os","device","original","version"]},"ingest._types__FieldAccessPattern":{"enum":["classic","flexible"]},"ingest._types__Document":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier for the document.\nThis ID must be unique within the `_index`."},"_index":{"type":"string","description":"Name of the index containing the document."},"_source":{"description":"JSON body for the document."}},"required":["_source"]},"ingest._types__SimulateDocumentResult":{"type":"object","properties":{"doc":{"$ref":"./ingest._types.json#/$defs/ingest._types__DocumentSimulation"},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"processor_results":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineProcessorResult"}}}},"ingest._types__DocumentSimulation":{"type":"object","additionalProperties":{}},"ingest._types__PipelineProcessorResult":{"type":"object","properties":{"doc":{"$ref":"./ingest._types.json#/$defs/ingest._types__DocumentSimulation"},"tag":{"type":"string"},"processor_type":{"type":"string"},"status":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineSimulationStatusOptions"},"description":{"type":"string"},"ignored_error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}}},"ingest._types__PipelineSimulationStatusOptions":{"enum":["success","error","error_ignored","skipped","dropped"]},"ingest._types__PipelineConfig":{"type":"object","properties":{"description":{"type":"string","description":"Description of the ingest pipeline."},"version":{"type":"number","description":"Version number used by external systems to track ingest pipelines."},"processors":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified."}},"required":["processors"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ingest._types__DatabaseConfiguration":{"type":"object","properties":{"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download."},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind"},"ipinfo":{"$ref":"./ingest._types.json#/$defs/ingest._types__Ipinfo"}},"required":["name"],"description":"The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured.\nA provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations."},"ingest._types__Maxmind":{"type":"object","properties":{"account_id":{"type":"string"}},"required":["account_id"]},"ingest._types__Ipinfo":{"type":"object","properties":{}},"ingest._types__DatabaseConfigurationFull":{"type":"object","properties":{"web":{"$ref":"./ingest._types.json#/$defs/ingest._types__Web"},"local":{"$ref":"./ingest._types.json#/$defs/ingest._types__Local"},"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download."},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind"},"ipinfo":{"$ref":"./ingest._types.json#/$defs/ingest._types__Ipinfo"}},"required":["name"]},"ingest._types__Web":{"type":"object","properties":{}},"ingest._types__Local":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]},"ingest._types__Pipeline":{"type":"object","properties":{"description":{"type":"string","description":"Description of the ingest pipeline."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors to run immediately after a processor failure."},"processors":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified."},"version":{"type":"number","description":"Version number used by external systems to track ingest pipelines."},"deprecated":{"type":"boolean","description":"Marks this ingest pipeline as deprecated.\nWhen 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."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch."},"created_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the pipeline was created. Only returned if the `human` query parameter is `true`."},"created_date_millis":{"description":"Date and time when the pipeline was created, in milliseconds since the epoch."},"modified_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the pipeline was last modified. Only returned if the `human` query parameter is `true`."},"modified_date_millis":{"description":"Date and time when the pipeline was last modified, in milliseconds since the epoch."},"field_access_pattern":{"$ref":"./ingest._types.json#/$defs/ingest._types__FieldAccessPattern","description":"Controls how processors in this pipeline should read and write data on a document's source."}}},"ingest._types__ProcessorContainer":{"type":"object","properties":{"append":{"$ref":"./ingest._types.json#/$defs/ingest._types__AppendProcessor","description":"Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values."},"attachment":{"$ref":"./ingest._types.json#/$defs/ingest._types__AttachmentProcessor","description":"The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika."},"bytes":{"$ref":"./ingest._types.json#/$defs/ingest._types__BytesProcessor","description":"Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63."},"cef":{"$ref":"./ingest._types.json#/$defs/ingest._types__CefProcessor","description":"Converts a CEF message into a structured format."},"circle":{"$ref":"./ingest._types.json#/$defs/ingest._types__CircleProcessor","description":"Converts circle definitions of shapes to regular polygons which approximate them."},"community_id":{"$ref":"./ingest._types.json#/$defs/ingest._types__CommunityIDProcessor","description":"Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow."},"convert":{"$ref":"./ingest._types.json#/$defs/ingest._types__ConvertProcessor","description":"Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted."},"csv":{"$ref":"./ingest._types.json#/$defs/ingest._types__CsvProcessor","description":"Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped."},"date":{"$ref":"./ingest._types.json#/$defs/ingest._types__DateProcessor","description":"Parses dates from fields, and then uses the date or timestamp as the timestamp for the document."},"date_index_name":{"$ref":"./ingest._types.json#/$defs/ingest._types__DateIndexNameProcessor","description":"The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support."},"dissect":{"$ref":"./ingest._types.json#/$defs/ingest._types__DissectProcessor","description":"Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern."},"dot_expander":{"$ref":"./ingest._types.json#/$defs/ingest._types__DotExpanderProcessor","description":"Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor."},"drop":{"$ref":"./ingest._types.json#/$defs/ingest._types__DropProcessor","description":"Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition."},"enrich":{"$ref":"./ingest._types.json#/$defs/ingest._types__EnrichProcessor","description":"The `enrich` processor can enrich documents with data from another index."},"fail":{"$ref":"./ingest._types.json#/$defs/ingest._types__FailProcessor","description":"Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester."},"fingerprint":{"$ref":"./ingest._types.json#/$defs/ingest._types__FingerprintProcessor","description":"Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting."},"foreach":{"$ref":"./ingest._types.json#/$defs/ingest._types__ForeachProcessor","description":"Runs an ingest processor on each element of an array or object."},"ip_location":{"$ref":"./ingest._types.json#/$defs/ingest._types__IpLocationProcessor","description":"Currently an undocumented alias for GeoIP Processor."},"geo_grid":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoGridProcessor","description":"Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields."},"geoip":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoIpProcessor","description":"The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address."},"grok":{"$ref":"./ingest._types.json#/$defs/ingest._types__GrokProcessor","description":"Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused."},"gsub":{"$ref":"./ingest._types.json#/$defs/ingest._types__GsubProcessor","description":"Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception."},"html_strip":{"$ref":"./ingest._types.json#/$defs/ingest._types__HtmlStripProcessor","description":"Removes HTML tags from the field.\nIf the field is an array of strings, HTML tags will be removed from all members of the array."},"inference":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceProcessor","description":"Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline."},"join":{"$ref":"./ingest._types.json#/$defs/ingest._types__JoinProcessor","description":"Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array."},"json":{"$ref":"./ingest._types.json#/$defs/ingest._types__JsonProcessor","description":"Parses a string containing JSON data into a structured object, string, or other value."},"kv":{"$ref":"./ingest._types.json#/$defs/ingest._types__KeyValueProcessor","description":"This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety."},"lowercase":{"$ref":"./ingest._types.json#/$defs/ingest._types__LowercaseProcessor","description":"Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted."},"network_direction":{"$ref":"./ingest._types.json#/$defs/ingest._types__NetworkDirectionProcessor","description":"Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks."},"pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineProcessor","description":"Executes another pipeline."},"redact":{"$ref":"./ingest._types.json#/$defs/ingest._types__RedactProcessor","description":"The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `<EMAIL>` where an email address is matched or simply replace all matches with the text `<REDACTED>` if preferred."},"registered_domain":{"$ref":"./ingest._types.json#/$defs/ingest._types__RegisteredDomainProcessor","description":"Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List."},"remove":{"$ref":"./ingest._types.json#/$defs/ingest._types__RemoveProcessor","description":"Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown."},"rename":{"$ref":"./ingest._types.json#/$defs/ingest._types__RenameProcessor","description":"Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown."},"reroute":{"$ref":"./ingest._types.json#/$defs/ingest._types__RerouteProcessor","description":"Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme."},"script":{"$ref":"./ingest._types.json#/$defs/ingest._types__ScriptProcessor","description":"Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context."},"set":{"$ref":"./ingest._types.json#/$defs/ingest._types__SetProcessor","description":"Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one."},"set_security_user":{"$ref":"./ingest._types.json#/$defs/ingest._types__SetSecurityUserProcessor","description":"Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest."},"sort":{"$ref":"./ingest._types.json#/$defs/ingest._types__SortProcessor","description":"Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array."},"split":{"$ref":"./ingest._types.json#/$defs/ingest._types__SplitProcessor","description":"Splits a field into an array using a separator character.\nOnly works on string fields."},"terminate":{"$ref":"./ingest._types.json#/$defs/ingest._types__TerminateProcessor","description":"Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option."},"trim":{"$ref":"./ingest._types.json#/$defs/ingest._types__TrimProcessor","description":"Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace."},"uppercase":{"$ref":"./ingest._types.json#/$defs/ingest._types__UppercaseProcessor","description":"Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted."},"urldecode":{"$ref":"./ingest._types.json#/$defs/ingest._types__UrlDecodeProcessor","description":"URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded."},"uri_parts":{"$ref":"./ingest._types.json#/$defs/ingest._types__UriPartsProcessor","description":"Parses a Uniform Resource Identifier (URI) string and extracts its components as an object.\nThis URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password."},"user_agent":{"$ref":"./ingest._types.json#/$defs/ingest._types__UserAgentProcessor","description":"The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field."}}},"ingest._types__AppendProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be appended to.\nSupports template snippets."},"value":{"anyOf":[{},{"type":"array","items":{}}],"description":"The value to be appended. Supports template snippets. May specify only one of `value` or `copy_from`."},"media_type":{"type":"string","description":"The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`."},"copy_from":{"type":"string","description":"The origin field which will be appended to `field`, cannot set `value` simultaneously."},"allow_duplicates":{"type":"boolean","description":"If `false`, the processor does not append values already present in the field."},"ignore_empty_values":{"type":"boolean","description":"If `true`, the processor will skip empty values from the source (e.g. empty strings, and null values),\nrather than appending them to the field."}},"required":["field"]},"ingest._types__AttachmentProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to get the base64 encoded field from."},"ignore_missing":{"type":"boolean","description":"If `true` and field does not exist, the processor quietly exits without modifying the document."},"indexed_chars":{"type":"number","description":"The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit."},"indexed_chars_field":{"type":"string","description":"Field name from which you can overwrite the number of chars being used for extraction."},"max_field_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Maximum allowed size of the attachment `field` value in bytes: length of a string (if base64 in JSON,\nchecked before base64 decoding) or byte array length for binary (for example, CBOR).\nIf set to `-1`, there is no per-processor limit.\nThe node setting `ingest.attachment.max_field_size` also applies."},"properties":{"type":"array","items":{"type":"string"},"description":"Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`."},"target_field":{"type":"string","description":"The field that will hold the attachment information."},"remove_binary":{"type":"boolean","description":"If true, the binary field will be removed from the document"},"resource_name":{"type":"string","description":"Field containing the name of the resource to decode.\nIf specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection."}},"required":["field"]},"ingest._types__BytesProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to convert."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__CefProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field containing the CEF message."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the `target_field` is 'cef'"},"ignore_empty_values":{"type":"boolean","description":"If `true` and value is anempty string in extensions, the processor quietly exits without modifying the document."},"timezone":{"type":"string","description":"The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names."}},"required":["field"]},"ingest._types__CircleProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"error_distance":{"type":"number","description":"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`)."},"field":{"type":"string","description":"The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"shape_type":{"$ref":"./ingest._types.json#/$defs/ingest._types__ShapeType","description":"Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`."},"target_field":{"type":"string","description":"The field to assign the polygon shape to\nBy default, the field is updated in-place."}},"required":["error_distance","field","shape_type"]},"ingest._types__ShapeType":{"enum":["geo_shape","shape"]},"ingest._types__CommunityIDProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"source_ip":{"type":"string","description":"Field containing the source IP address."},"source_port":{"type":"string","description":"Field containing the source port."},"destination_ip":{"type":"string","description":"Field containing the destination IP address."},"destination_port":{"type":"string","description":"Field containing the destination port."},"iana_number":{"type":"string","description":"Field containing the IANA number."},"icmp_type":{"type":"string","description":"Field containing the ICMP type."},"icmp_code":{"type":"string","description":"Field containing the ICMP code."},"transport":{"type":"string","description":"Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp"},"target_field":{"type":"string","description":"Output field for the community ID."},"seed":{"type":"number","description":"Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme."},"ignore_missing":{"type":"boolean","description":"If true and any required fields are missing, the processor quietly exits\nwithout modifying the document."}}},"ingest._types__ConvertProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field whose value is to be converted."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the `field` is updated in-place."},"type":{"$ref":"./ingest._types.json#/$defs/ingest._types__ConvertType","description":"The type to convert the existing value to."}},"required":["field","type"]},"ingest._types__ConvertType":{"enum":["integer","long","double","float","boolean","ip","string","auto"]},"ingest._types__CsvProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"empty_value":{"description":"Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`)."},"field":{"type":"string","description":"The field to extract data from."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"quote":{"type":"string","description":"Quote used in CSV, has to be single character string."},"separator":{"type":"string","description":"Separator used in CSV, has to be single character string."},"target_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The array of fields to assign extracted values to."},"trim":{"type":"boolean","description":"Trim whitespaces in unquoted fields."}},"required":["field","target_fields"]},"ingest._types__DateProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to get the date from."},"formats":{"type":"array","items":{"type":"string"},"description":"An array of the expected date formats.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N."},"locale":{"type":"string","description":"The locale to use when parsing the date, relevant when parsing month names or week days.\nSupports template snippets."},"target_field":{"type":"string","description":"The field that will hold the parsed date."},"timezone":{"type":"string","description":"The timezone to use when parsing the date.\nSupports template snippets."},"output_format":{"type":"string","description":"The format to use when writing the date to target_field. Must be a valid\njava time pattern."}},"required":["field","formats"]},"ingest._types__DateIndexNameProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"date_formats":{"type":"array","items":{"type":"string"},"description":"An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N."},"date_rounding":{"type":"string","description":"How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets."},"field":{"type":"string","description":"The field to get the date or timestamp from."},"index_name_format":{"type":"string","description":"The format to be used when printing the parsed date into the index name.\nA valid java time pattern is expected here.\nSupports template snippets."},"index_name_prefix":{"type":"string","description":"A prefix of the index name to be prepended before the printed date.\nSupports template snippets."},"locale":{"type":"string","description":"The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days."},"timezone":{"type":"string","description":"The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names."}},"required":["date_rounding","field"]},"ingest._types__DissectProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"append_separator":{"type":"string","description":"The character(s) that separate the appended fields."},"field":{"type":"string","description":"The field to dissect."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"pattern":{"type":"string","description":"The pattern to apply to the field."}},"required":["field","pattern"]},"ingest._types__DotExpanderProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to expand into an object field.\nIf set to `*`, all top-level fields will be expanded."},"override":{"type":"boolean","description":"Controls the behavior when there is already an existing nested object that conflicts with the expanded field.\nWhen `false`, the processor will merge conflicts by combining the old and the new values into an array.\nWhen `true`, the value from the expanded field will overwrite the existing value."},"path":{"type":"string","description":"The field that contains the field to expand.\nOnly required if the field to expand is part another object field, because the `field` option can only understand leaf fields."}},"required":["field"]},"ingest._types__DropProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."}}},"ingest._types__EnrichProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field in the input document that matches the policies match_field used to retrieve the enrichment data.\nSupports template snippets."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"max_matches":{"type":"number","description":"The maximum number of matched documents to include under the configured target field.\nThe `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.\nIn order to avoid documents getting too large, the maximum allowed value is 128."},"override":{"type":"boolean","description":"If processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched."},"policy_name":{"type":"string","description":"The name of the enrich policy to use."},"shape_relation":{"$ref":"./_types.json#/$defs/_types__GeoShapeRelation","description":"A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.\nThis option is only used for `geo_match` enrich policy types."},"target_field":{"type":"string","description":"Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.\nSupports template snippets."}},"required":["field","policy_name","target_field"]},"ingest._types__FailProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"message":{"type":"string","description":"The error message thrown by the processor.\nSupports template snippets."}},"required":["message"]},"ingest._types__FingerprintProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value."},"target_field":{"type":"string","description":"Output field for the fingerprint."},"salt":{"type":"string","description":"Salt value for the hash function."},"method":{"$ref":"./ingest._types.json#/$defs/ingest._types__FingerprintDigest","description":"The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3."},"ignore_missing":{"type":"boolean","description":"If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document."}},"required":["fields"]},"ingest._types__FingerprintDigest":{"enum":["md5","sha1","sha256","sha512","murmurHash3"]},"ingest._types__ForeachProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing array or object values."},"ignore_missing":{"type":"boolean","description":"If `true`, the processor silently exits without changing the document if the `field` is `null` or missing."},"processor":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer","description":"Ingest processor to run on each element."}},"required":["field","processor"]},"ingest._types__IpLocationProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"database_file":{"type":"string","description":"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."},"field":{"type":"string","description":"The field to get the ip address from for the geographical lookup."},"first_only":{"type":"boolean","description":"If `true`, only the first found IP location data will be returned, even if the field contains an array."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"properties":{"type":"array","items":{"type":"string"},"description":"Controls what properties are added to the `target_field` based on the IP location lookup."},"target_field":{"type":"string","description":"The field that will hold the geographical information looked up from the MaxMind database."},"download_database_on_pipeline_creation":{"type":"boolean","description":"If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index."}},"required":["field"]},"ingest._types__GeoGridProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to interpret as a geo-tile.=\nThe field format is determined by the `tile_type`."},"tile_type":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoGridTileType","description":"Three tile formats are understood: geohash, geotile and geohex."},"target_field":{"type":"string","description":"The field to assign the polygon shape to, by default, the `field` is updated in-place."},"parent_field":{"type":"string","description":"If specified and a parent tile exists, save that tile address to this field."},"children_field":{"type":"string","description":"If specified and children tiles exist, save those tile addresses to this field as an array of strings."},"non_children_field":{"type":"string","description":"If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings."},"precision_field":{"type":"string","description":"If specified, save the tile precision (zoom) as an integer to this field."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"target_format":{"$ref":"./ingest._types.json#/$defs/ingest._types__GeoGridTargetFormat","description":"Which format to save the generated polygon in."}},"required":["field","tile_type"]},"ingest._types__GeoGridTileType":{"enum":["geotile","geohex","geohash"]},"ingest._types__GeoGridTargetFormat":{"enum":["geojson","wkt"]},"ingest._types__GeoIpProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"database_file":{"type":"string","description":"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."},"field":{"type":"string","description":"The field to get the ip address from for the geographical lookup."},"first_only":{"type":"boolean","description":"If `true`, only the first found geoip data will be returned, even if the field contains an array."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"properties":{"type":"array","items":{"type":"string"},"description":"Controls what properties are added to the `target_field` based on the geoip lookup."},"target_field":{"type":"string","description":"The field that will hold the geographical information looked up from the MaxMind database."},"download_database_on_pipeline_creation":{"type":"boolean","description":"If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index."}},"required":["field"]},"ingest._types__GrokProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"ecs_compatibility":{"type":"string","description":"Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names."},"field":{"type":"string","description":"The field to use for grok expression parsing."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"pattern_definitions":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.\nPatterns matching existing names will override the pre-existing definition."},"patterns":{"type":"array","items":{"type":"string"},"description":"An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches."},"trace_match":{"type":"boolean","description":"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."},"validate_only":{"type":"boolean","description":"When `true`, the processor does matching but does not extract structured fields"}},"required":["field","patterns"]},"ingest._types__GsubProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to apply the replacement to."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"pattern":{"type":"string","description":"The pattern to be replaced."},"replacement":{"type":"string","description":"The string to replace the matching patterns with."},"target_field":{"type":"string","description":"The field to assign the converted value to\nBy default, the `field` is updated in-place."}},"required":["field","pattern","replacement"]},"ingest._types__HtmlStripProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The string-valued field to remove HTML tags from."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document,"},"target_field":{"type":"string","description":"The field to assign the converted value to\nBy default, the `field` is updated in-place."}},"required":["field"]},"ingest._types__InferenceProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"model_id":{"type":"string","description":"The ID or alias for the trained model, or the ID of the deployment."},"target_field":{"type":"string","description":"Field added to incoming documents to contain results objects."},"field_map":{"type":"object","additionalProperties":{},"description":"Maps the document field names to the known field names of the model.\nThis mapping takes precedence over any default mappings provided in the model configuration."},"inference_config":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceConfig","description":"Contains the inference type and its options."},"input_output":{"anyOf":[{"$ref":"./ingest._types.json#/$defs/ingest._types__InputConfig"},{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__InputConfig"}}],"description":"Input fields for inference and output (destination) fields for the inference results.\nThis option is incompatible with the target_field and field_map options."},"ignore_missing":{"type":"boolean","description":"If true and any of the input fields defined in input_ouput are missing\nthen those missing fields are quietly ignored, otherwise a missing field causes a failure.\nOnly applies when using input_output configurations to explicitly list the input fields."}},"required":["model_id"]},"ingest._types__InferenceConfig":{"type":"object","properties":{"regression":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceConfigRegression","description":"Regression configuration for inference."},"classification":{"$ref":"./ingest._types.json#/$defs/ingest._types__InferenceConfigClassification","description":"Classification configuration for inference."}}},"ingest._types__InferenceConfigRegression":{"type":"object","properties":{"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."}}},"ingest._types__InferenceConfigClassification":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction."},"top_classes_results_field":{"type":"string","description":"Specifies the field to which the top classes are written."},"prediction_field_type":{"type":"string","description":"Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`."}}},"ingest._types__InputConfig":{"type":"object","properties":{"input_field":{"type":"string"},"output_field":{"type":"string"}},"required":["input_field","output_field"]},"ingest._types__JoinProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing array values to join."},"separator":{"type":"string","description":"The separator character."},"target_field":{"type":"string","description":"The field to assign the joined value to.\nBy default, the field is updated in-place."}},"required":["field","separator"]},"ingest._types__JsonProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"add_to_root":{"type":"boolean","description":"Flag that forces the parsed JSON to be added at the top level of the document.\n`target_field` must not be set when this option is chosen."},"add_to_root_conflict_strategy":{"$ref":"./ingest._types.json#/$defs/ingest._types__JsonProcessorConflictStrategy","description":"When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.\nWhen set to `merge`, conflicting fields will be merged.\nOnly applicable `if add_to_root` is set to true."},"allow_duplicate_keys":{"type":"boolean","description":"When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.\nInstead, the last encountered value for any duplicate key wins."},"field":{"type":"string","description":"The field to be parsed."},"target_field":{"type":"string","description":"The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten."}},"required":["field"]},"ingest._types__JsonProcessorConflictStrategy":{"enum":["replace","merge"]},"ingest._types__KeyValueProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"exclude_keys":{"type":"array","items":{"type":"string"},"description":"List of keys to exclude from document."},"field":{"type":"string","description":"The field to be parsed.\nSupports template snippets."},"field_split":{"type":"string","description":"Regex pattern to use for splitting key-value pairs."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"include_keys":{"type":"array","items":{"type":"string"},"description":"List of keys to filter and insert into document.\nDefaults to including all keys."},"prefix":{"type":"string","description":"Prefix to be added to extracted keys."},"strip_brackets":{"type":"boolean","description":"If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values."},"target_field":{"type":"string","description":"The field to insert the extracted keys into.\nDefaults to the root of the document.\nSupports template snippets."},"trim_key":{"type":"string","description":"String of characters to trim from extracted keys."},"trim_value":{"type":"string","description":"String of characters to trim from extracted values."},"value_split":{"type":"string","description":"Regex pattern to use for splitting the key from the value within a key-value pair."}},"required":["field","field_split","value_split"]},"ingest._types__LowercaseProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to make lowercase."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__NetworkDirectionProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"source_ip":{"type":"string","description":"Field containing the source IP address."},"destination_ip":{"type":"string","description":"Field containing the destination IP address."},"target_field":{"type":"string","description":"Output field for the network direction."},"internal_networks":{"type":"array","items":{"type":"string"},"description":"List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field."},"internal_networks_field":{"type":"string","description":"A field on the given document to read the internal_networks configuration\nfrom."},"ignore_missing":{"type":"boolean","description":"If true and any required fields are missing, the processor quietly exits\nwithout modifying the document."}}},"ingest._types__PipelineProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"name":{"type":"string","description":"The name of the pipeline to execute.\nSupports template snippets."},"ignore_missing_pipeline":{"type":"boolean","description":"Whether to ignore missing pipelines instead of failing."}},"required":["name"]},"ingest._types__RedactProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be redacted"},"patterns":{"type":"array","items":{"type":"string"},"description":"A list of grok expressions to match and redact named captures with"},"pattern_definitions":{"type":"object","additionalProperties":{"type":"string"}},"prefix":{"type":"string","description":"Start a redacted section with this token"},"suffix":{"type":"string","description":"End a redacted section with this token"},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"skip_if_unlicensed":{"type":"boolean","description":"If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document"},"trace_redact":{"type":"boolean","description":"If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted"}},"required":["field","patterns"]},"ingest._types__RegisteredDomainProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing the source FQDN."},"target_field":{"type":"string","description":"Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root."},"ignore_missing":{"type":"boolean","description":"If true and any required fields are missing, the processor quietly exits\nwithout modifying the document."}},"required":["field"]},"ingest._types__RemoveProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Fields to be removed. Supports template snippets."},"keep":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Fields to be kept. When set, all fields other than those specified are removed."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."}},"required":["field"]},"ingest._types__RenameProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be renamed.\nSupports template snippets."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The new name of the field.\nSupports template snippets."}},"required":["field","target_field"]},"ingest._types__RerouteProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"destination":{"type":"string","description":"A static value for the target. Can’t be set when the dataset or namespace option is set."},"dataset":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Field references or a static value for the dataset part of the data stream name.\nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.\nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the <dataset> part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}"},"namespace":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the <namespace> part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}"}}},"ingest._types__ScriptProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"id":{"type":"string","description":"ID of a stored script.\nIf no `source` is specified, this parameter is required."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Script language."},"params":{"type":"object","additionalProperties":{},"description":"Object containing parameters for the script."},"source":{"$ref":"./_types.json#/$defs/_types__ScriptSource","description":"Inline script.\nIf no `id` is specified, this parameter is required."}}},"ingest._types__SetProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"copy_from":{"type":"string","description":"The origin field which will be copied to `field`, cannot set `value` simultaneously.\nSupported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc."},"field":{"type":"string","description":"The field to insert, upsert, or update.\nSupports template snippets."},"ignore_empty_value":{"type":"boolean","description":"If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document."},"media_type":{"type":"string","description":"The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`."},"override":{"type":"boolean","description":"If `true` processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched."},"value":{"description":"The value to be set for the field.\nSupports template snippets.\nMay specify only one of `value` or `copy_from`."}},"required":["field"]},"ingest._types__SetSecurityUserProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to store the user information into."},"properties":{"type":"array","items":{"type":"string"},"description":"Controls what user related properties are added to the field."}},"required":["field"]},"ingest._types__SortProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to be sorted."},"order":{"$ref":"./_types.json#/$defs/_types__SortOrder","description":"The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`."},"target_field":{"type":"string","description":"The field to assign the sorted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__SplitProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to split."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"preserve_trailing":{"type":"boolean","description":"Preserves empty trailing fields, if any."},"separator":{"type":"string","description":"A regex which matches the separator, for example, `,` or `\\s+`."},"target_field":{"type":"string","description":"The field to assign the split value to.\nBy default, the field is updated in-place."}},"required":["field","separator"]},"ingest._types__TerminateProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."}}},"ingest._types__TrimProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The string-valued field to trim whitespace from."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the trimmed value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__UppercaseProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to make uppercase."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__UrlDecodeProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field to decode."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."},"target_field":{"type":"string","description":"The field to assign the converted value to.\nBy default, the field is updated in-place."}},"required":["field"]},"ingest._types__UriPartsProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"Field containing the URI string."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"keep_original":{"type":"boolean","description":"If `true`, the processor copies the unparsed URI to `<target_field>.original`."},"remove_if_successful":{"type":"boolean","description":"If `true`, the processor removes the `field` after parsing the URI string.\nIf parsing fails, the processor does not remove the `field`."},"target_field":{"type":"string","description":"Output field for the URI object."}},"required":["field"]},"ingest._types__UserAgentProcessor":{"type":"object","properties":{"description":{"type":"string","description":"Description of the processor.\nUseful for describing the purpose of the processor or its configuration."},"if":{"$ref":"./_types.json#/$defs/_types__Script","description":"Conditionally execute the processor."},"ignore_failure":{"type":"boolean","description":"Ignore failures for the processor."},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Handle failures for the processor."},"tag":{"type":"string","description":"Identifier for the processor.\nUseful for debugging and metrics."},"field":{"type":"string","description":"The field containing the user agent string."},"ignore_missing":{"type":"boolean","description":"If `true` and `field` does not exist, the processor quietly exits without modifying the document."},"regex_file":{"type":"string","description":"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."},"target_field":{"type":"string","description":"The field that will be filled with the user agent details."},"properties":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__UserAgentProperty"},"description":"Controls what properties are added to `target_field`."},"extract_device_type":{"type":"boolean","description":"Extracts device type from the user agent string on a best-effort basis."}},"required":["field"]},"ingest._types__UserAgentProperty":{"enum":["name","os","device","original","version"]},"ingest._types__FieldAccessPattern":{"enum":["classic","flexible"]},"ingest._types__Document":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier for the document.\nThis ID must be unique within the `_index`."},"_index":{"type":"string","description":"Name of the index containing the document."},"_source":{"description":"JSON body for the document."}},"required":["_source"]},"ingest._types__SimulateDocumentResult":{"type":"object","properties":{"doc":{"$ref":"./ingest._types.json#/$defs/ingest._types__DocumentSimulation"},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"processor_results":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineProcessorResult"}}}},"ingest._types__DocumentSimulation":{"type":"object","additionalProperties":{}},"ingest._types__PipelineProcessorResult":{"type":"object","properties":{"doc":{"$ref":"./ingest._types.json#/$defs/ingest._types__DocumentSimulation"},"tag":{"type":"string"},"processor_type":{"type":"string"},"status":{"$ref":"./ingest._types.json#/$defs/ingest._types__PipelineSimulationStatusOptions"},"description":{"type":"string"},"ignored_error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}}},"ingest._types__PipelineSimulationStatusOptions":{"enum":["success","error","error_ignored","skipped","dropped"]},"ingest._types__PipelineConfig":{"type":"object","properties":{"description":{"type":"string","description":"Description of the ingest pipeline."},"version":{"type":"number","description":"Version number used by external systems to track ingest pipelines."},"processors":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified."}},"required":["processors"]}}}

package/src/es/json/ingest.put_geoip_database.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_geoip_database","type":"object","properties":{"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download.","x-found-in":"body"},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind","description":"The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"id":{"type":"string","description":"ID of the database configuration to create or update.","x-found-in":"path"}},"required":["id","name","maxmind"],"description":"Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_geoip_database","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download.","x-found-in":"body"},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind","description":"The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.","x-found-in":"body"},"id":{"type":"string","description":"ID of the database configuration to create or update.","x-found-in":"path"}},"required":["id","name","maxmind"],"description":"Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API."}