.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Search::Elasticsearch::Client::8_0::Direct::Ingest 3pm"
.TH Search::Elasticsearch::Client::8_0::Direct::Ingest 3pm 2024-02-04 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Search::Elasticsearch::Client::8_0::Direct::Ingest \- A client for accessing the Ingest API
.SH VERSION
.IX Header "VERSION"
version 8.12
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides methods to access the Ingest API, such as creating,
getting, deleting and simulating ingest pipelines.
.PP
It does Search::Elasticsearch::Role::Client::Direct.
.SH METHODS
.IX Header "METHODS"
.ie n .SS put_pipeline()
.el .SS \f(CWput_pipeline()\fP
.IX Subsection "put_pipeline()"
.Vb 4
\&    $response = $e\->ingest\->put_pipeline(
\&        id   => $id,                # required
\&        body => { pipeline defn }   # required
\&    );
.Ve
.PP
The \f(CWput_pipeline()\fR method creates or updates a pipeline with the specified ID.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`timeout\*(C'\fR
.PP
See the put pipeline docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html>
for more information.
.ie n .SS get_pipeline()
.el .SS \f(CWget_pipeline()\fP
.IX Subsection "get_pipeline()"
.Vb 3
\&    $response = $e\->ingest\->get_pipeline(
\&        id   => \e@id,               # optional
\&    );
.Ve
.PP
The \f(CWget_pipeline()\fR method returns pipelines with the specified IDs (or all pipelines).
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`timeout\*(C'\fR
.PP
See the get pipeline docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html>
for more information.
.ie n .SS delete_pipeline()
.el .SS \f(CWdelete_pipeline()\fP
.IX Subsection "delete_pipeline()"
.Vb 3
\&    $response = $e\->ingest\->delete_pipeline(
\&        id   => $id,                # required
\&    );
.Ve
.PP
The \f(CWdelete_pipeline()\fR method deletes the pipeline with the specified ID.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`timeout\*(C'\fR
.PP
See the delete pipeline docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html>
for more information.
.ie n .SS simulate()
.el .SS \f(CWsimulate()\fP
.IX Subsection "simulate()"
.Vb 4
\&    $response = $e\->ingest\->put_pipeline(
\&        id   => $id,                # optional
\&        body => { simulate args }   # required
\&    );
.Ve
.PP
The \f(CWsimulate()\fR method executes the pipeline specified by ID or inline in the body
against the docs provided in the body and provides debugging output of the execution
process.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`verbose\*(C'\fR
.PP
See the simulate pipeline docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html>
for more information.
.ie n .SS simulate()
.el .SS \f(CWsimulate()\fP
.IX Subsection "simulate()"
.Vb 4
\&    $response = $e\->ingest\->put_pipeline(
\&        id   => $id,                # optional
\&        body => { simulate args }   # required
\&    );
.Ve
.PP
The \f(CWsimulate()\fR method executes the pipeline specified by ID or inline in the body
against the docs provided in the body and provides debugging output of the execution
process.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`verbose\*(C'\fR
.PP
See the simulate pipeline docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html>
for more information.
.ie n .SS """processor_grok"""
.el .SS \f(CWprocessor_grok\fP
.IX Subsection "processor_grok"
.Vb 1
\&    $response = $e\->inges\->processor_grok()
.Ve
.PP
Retrieves the configured patterns associated with the Grok processor.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR
.PP
See the grok processor docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html>
for more information.
.SH AUTHOR
.IX Header "AUTHOR"
Enrico Zimuel <enrico.zimuel@elastic.co>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2024 by Elasticsearch BV.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve