Search...Ingest(3pm)

📦 version 7.715, in ubuntu jammy

💖 Search...Ingest(3pm) 💖

okay bestie, so this is the Search...Ingest(3pm) page — user-contributed Perl documentation, section 3pm, the whole thing. And the module it's actually about is Search::Elasticsearch::Client::7_0::Direct::Ingest, which is a client for accessing the Ingest API. slay. let's get into it 💅

🌈 VERSION 🌈

version 7.715 ✨

🦋 DESCRIPTION 🦋

so this module is giving you the methods to hit up the Ingest API — creating pipelines, getting pipelines, deleting pipelines, and simulating them. that's the vibe. 🎀

it does Search::Elasticsearch::Role::Client::Direct. iykyk. 👑

👑 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 specified. main character behavior fr. 💖

Query string parameters:

  • error_trace
  • human
  • master_timeout
  • timeout

head over to the put pipeline docs at https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html if you want more. 📖

get_pipeline()

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

the get_pipeline() method hands you back the pipelines with the IDs you asked for — or literally all the pipelines if you don't specify any. 🌸

Query string parameters:

  • error_trace
  • human
  • master_timeout
  • timeout

more deets in the get pipeline docs at https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html ✨

delete_pipeline()

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

the delete_pipeline() method deletes the pipeline with the ID you specified. gone. bye. not me being the villain era 💀

Query string parameters:

  • error_trace
  • human
  • master_timeout
  • timeout

the delete pipeline docs live at https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html 🦋

simulate()

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

the simulate() method runs the pipeline — either the one named by ID or the inline one in the body — against the docs you put in the body, and then gives you debugging output of the whole execution process. it's giving test run, it's giving rehearsal. 🔥

Query string parameters:

  • error_trace
  • human
  • verbose

simulate pipeline docs, right this way: https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html 💜

simulate()

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

yes bestie, it's listed again — same method, same energy. the simulate() 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. 😌

Query string parameters:

  • error_trace
  • human
  • verbose

same simulate pipeline docs, same link: https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html 🎀

processor_grok

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

the processor_grok method retrieves the configured patterns that go with the Grok processor. iconic honestly. 🧚

Query string parameters:

  • error_trace
  • human

grok processor docs are at https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html ⭐

🫶 AUTHOR 🫶

Enrico Zimuel <enrico.zimuel@elastic.co> — thank you for your service king 👑

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004
and that's the whole page, no notes 💖

and finally, the lil sign-off from the footer: this page is for perl v5.32.1, dated 2021-10-23, and yes it's the Search...Ingest(3pm) page. periodt. 🌈✨💅

📦 where this page comes from