elasticsearch-js/docs/reference/api/IngestPutPipelineRequest.md

IngestPutPipelineRequest [interface-IngestPutPipelineRequest]

Name	Type	Description
_meta	Metadata	Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.
body	string	({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; if_version?: never; _meta?: never; description?: never; on_failure?: never; processors?: never; version?: never; deprecated?: never; })
deprecated	boolean	Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.
description	string	Description of the ingest pipeline.
id	Id	ID of the ingest pipeline to create or update.
if_version	VersionNumber	Required version for optimistic concurrency control for pipeline updates
master_timeout	Duration	Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
on_failure	IngestProcessorContainer[]	Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.
processors	IngestProcessorContainer[]	Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
querystring	{ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; if_version?: never; _meta?: never; description?: never; on_failure?: never; processors?: never; version?: never; deprecated?: never; }	All values in querystring will be added to the request querystring.
timeout	Duration	Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
version	VersionNumber	Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.