---
name: "Search::Elasticsearch::Client::6_0::Direct::Ingest"
section: "3pm"
platform: "linux"
package: "libsearch-elasticsearch-perl"
version: "6.00-1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/Search::Elasticsearch::Client::6_0::Direct::Ingest"
---

# Search::Elasticsearch::Client::6\_0::Direct::Ingest(3pm)

A client for accessing the Ingest API

## NAME

Search::Elasticsearch::Client::6\_0::Direct::Ingest - A client for accessing the Ingest API

## VERSION

version 6.00

## DESCRIPTION

This module provides methods to access the Ingest API, such as creating, getting, deleting and simulating ingest pipelines.

It does Search::Elasticsearch::Role::Client::Direct.

## 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 specified ID.

Query string parameters:\
     `"error_trace"`,\
     `"human"`,\
     `"master_timeout"`,\
     `"timeout"`

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

### "get\_pipeline()"

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

The `"get_pipeline()"` method returns pipelines with the specified IDs (or all pipelines).

Query string parameters:\
     `"error_trace"`,\
     `"human"`,\
     `"master_timeout"`,\
     `"timeout"`

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

### "delete\_pipeline()"

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

The `"delete_pipeline()"` method deletes the pipeline with the specified ID.

Query string parameters:\
     `"error_trace"`,\
     `"human"`,\
     `"master_timeout"`,\
     `"timeout"`

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

### "simulate()"

```
    $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 provides debugging output of the execution process.

Query string parameters:\
     `"error_trace"`,\
     `"human"`,\
     `"verbose"`

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

### "simulate()"

```
    $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 provides debugging output of the execution process.

Query string parameters:\
     `"error_trace"`,\
     `"human"`,\
     `"verbose"`

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

### "processor\_grok"

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

Retrieves the configured patterns associated with the Grok processor.

Query string parameters:\
     `"error_trace"`,\
     `"human"`

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

## AUTHOR

Clinton Gormley \<drtech@cpan.org\>

## COPYRIGHT AND LICENSE

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

This is free software, licensed under:

```
  The Apache License, Version 2.0, January 2004
```