IMPORTANT: Version 6.6 of Elasticsearch has passed its maintenance date.
This documentation is no longer being updated. For the latest information, see the current release documentation.
index action to index data into Elasticsearch.
See Index action attributes for the supported attributes.
The following snippet shows a simple
index action definition:
The id of the action
An optional condition to restrict action execution
An optional transform to transform the payload and prepare the data that should be indexed
The elasticsearch index to store the data to
The document type to store the data as
The Elasticsearch index to index into.
The type of the document the data will be indexed as.
The field that will store/index the watch execution time.
The timeout for waiting for the index api call to return. If no response is returned within this time, the index action times out and fails. This setting overrides the default timeouts.
Optional setting of the refresh policy for the write request
Like with all other actions, you can use a transform to replace the current execution context payload with another and by that change the document that will end up indexed.
The index action plays well with transforms with its support for the special
When resolving the document to be indexed, the index action first looks up for a
_doc field in the payload. When not found, the payload is indexed as a single
_doc field exists, if the field holds an object, it is extracted and indexed
as a single document. If the field holds an array of objects, each object is treated as
a document and the index action indexes all of them in a bulk.
_id value can be added per document to dynamically set the ID
of the indexed document.