/ 
Search-Elasticsearch-5.01
River stage two • 40 direct dependents • 55 total dependents
/ Search::Elasticsearch::Client::5_0::Direct::Ingest

NAME

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

VERSION

version 5.01

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 specfied ID.

Query string parameters: master_timeout, timeout

See the put pipeline docs 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: master_timeout, timeout

See the get pipeline docs for more information.

delete_pipeline()

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

The delete_pipeline() method deletes the pipeline with the specfied ID.

Query string parameters: master_timeout, timeout

See the delete pipeline docs 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: verbose

See the simulate pipeline docs for more information.

AUTHOR

Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004