Search...Ingest(3pm)

💖 NAME 💖

okay so bestie, welcome to Search::Elasticsearch::Client::8_0::Direct::Ingest — it's a whole client for talking to the Ingest API. Yes it's a Perl module (the (3pm) at the top is just its little manual-page birthmark, iykyk). 🌸

---

✨ VERSION ✨

version 8.12 — that's the vibe check, and it passed. 💅

---

🦋 DESCRIPTION 🦋

So basically this module hands you the methods you need to hit up the Ingest API — think creating, getting, deleting and simulating ingest pipelines. All the pipeline stuff. All of it. Obsessed. 🎀

It also does Search::Elasticsearch::Role::Client::Direct. That's the role it carries, no cap.

---

👑 METHODS 👑

🌟 put_pipeline()

$response = $e->ingest->put_pipeline(
    id   => $id,                # required
    body => { pipeline defn }   # required
);

The put_pipeline() method creates or updates a pipeline with the ID you gave it. New pipeline? Updated pipeline? It doesn't care, it slays either way. ✨

Query string parameters:

• "error_trace"
• "human"
• "master_timeout"
• "timeout"

See the put pipeline docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html> for more info. 🫶

---

🌸 get_pipeline()

$response = $e->ingest->get_pipeline(
    id   => \@id,               # optional
);

The get_pipeline() method returns the pipelines with the IDs you asked for — or, if you don't specify, all the pipelines. Main character energy, it's giving generous. 😭

Query string parameters:

• "error_trace"
• "human"
• "master_timeout"
• "timeout"

See the get pipeline docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html> for more info. 💖

---

🎀 delete_pipeline()

$response = $e->ingest->delete_pipeline(
    id   => $id,                # required
);

The delete_pipeline() method deletes the pipeline with the ID you specified. Gone. Poof. Not me crying over a pipeline 💀

Query string parameters:

• "error_trace"
• "human"
• "master_timeout"
• "timeout"

See the delete pipeline docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html> for more info. 🧚

---

⭐ simulate()

$response = $e->ingest->put_pipeline(
    id   => $id,                # optional
    body => { simulate args }   # required
);

The simulate() method runs the pipeline — either the one you named by ID or the one you wrote inline in the body — against the docs you put in the body, and then gives you the debugging output of the whole execution process. It's the rehearsal, bestie. 🌈

Query string parameters:

• "error_trace"
• "human"
• "verbose"

See the simulate pipeline docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html> for more info. 💜

---

⭐ simulate() (yes, again, and we're not sorry)

$response = $e->ingest->put_pipeline(
    id   => $id,                # optional
    body => { simulate args }   # required
);

The simulate() method executes the pipeline specified by ID or inline in the body against the docs provided in the body, and gives you debugging output of the execution process. Same energy, twice the icon. 👑

Query string parameters:

• "error_trace"
• "human"
• "verbose"

See the simulate pipeline docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html> for more info. 🍓

---

💅 "processor_grok"

$response = $e->inges->processor_grok()

Retrieves the configured patterns associated with the Grok processor. Grok processor patterns, unlocked. 🔥

Query string parameters:

• "error_trace"
• "human"

See the grok processor docs at <https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html> for more info. 🌟

---

💖 AUTHOR 💖

Enrico Zimuel <enrico.zimuel@elastic.co> — shoutout to the legend, fr fr 🫶

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is Copyright (c) 2024 by Elasticsearch BV.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

ok that's the whole page bestie, go forth and ingest 💖✨

and that's a wrap — brought to you by perl v5.38.2, dated 2024-02-04, straight out of the Search...Ingest(3pm) manual. mwah 💋