/ 
OpenSearch-Client-3.007002
/ OpenSearch::Client::Core::3_0::Direct::Ingest

NAME

OpenSearch::Client::Core::3_0::Direct::Ingest

VERSION

version 3.007002

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->ingest-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Ingest APIs

Ingest APIs are a valuable tool for loading data into a system. Ingest APIs work together with ingest pipelines and ingest processors to process or transform data from a variety of sources and in a variety of formats.

See OpenSearch documentation for ingest.

METHODS

ingest->delete_pipeline

Deletes an ingest pipeline.

Paths served by this method:

DELETE /_ingest/pipeline/{id}
$resp = $client->ingest->delete_pipeline(
    
     # path parameters
    
    'id'                       =>  $id,        # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    'timeout'                  =>  $qval3,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval4,     # boolean
    'filter_path'              =>  $qval5,     # list
    'human'                    =>  $qval6,     # boolean
    'pretty'                   =>  $qval7,     # boolean
    'source'                   =>  $qval8,     # string
);

OpenSearch documentation for ingest.delete_pipeline

ingest->get_pipeline

Returns an ingest pipeline.

Paths served by this method:

GET /_ingest/pipeline
GET /_ingest/pipeline/{id}
$resp = $client->ingest->get_pipeline(
    
     # path parameters
    
    'id'                       =>  $id,        # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval3,     # boolean
    'filter_path'              =>  $qval4,     # list
    'human'                    =>  $qval5,     # boolean
    'pretty'                   =>  $qval6,     # boolean
    'source'                   =>  $qval7,     # string
);

OpenSearch documentation for ingest.get_pipeline

ingest->processor_grok

Returns a list of built-in grok patterns.

Paths served by this method:

GET /_ingest/processor/grok
$resp = $client->ingest->processor_grok(
    
     # Endpoint specific query string parameters
    
    's'            =>  $qval1,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for ingest.processor_grok

ingest->put_pipeline

Creates or updates an ingest pipeline.

Paths served by this method:

PUT /_ingest/pipeline/{id}
$resp = $client->ingest->put_pipeline(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'id'                       =>  $id,        # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'master_timeout'           =>  $qval2,     # string
    'timeout'                  =>  $qval3,     # string
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval4,     # boolean
    'filter_path'              =>  $qval5,     # list
    'human'                    =>  $qval6,     # boolean
    'pretty'                   =>  $qval7,     # boolean
    'source'                   =>  $qval8,     # string
);

OpenSearch documentation for ingest.put_pipeline

ingest->simulate

Simulates an ingest pipeline with example documents.

Paths served by this method:

GET /_ingest/pipeline/_simulate
GET /_ingest/pipeline/{id}/_simulate
POST /_ingest/pipeline/_simulate
POST /_ingest/pipeline/{id}/_simulate
$resp = $client->ingest->simulate(
    
    'body'         =>  $body,      # required
    
     # path parameters
    
    'id'           =>  $id,        # optional
    
     # Endpoint specific query string parameters
    
    'verbose'      =>  $qval1,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for ingest.simulate

MANUAL

Documentation index OpenSearch::Client::Manual

HISTORY

This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.

AUTHOR

Mark Dootson <mdootson@cpan.org> ( current maintainer )

CREDITS

OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.

COPYRIGHT AND LICENSE

Copyright (C) 2026 by Mark Dootson ( this distribution )

Copyright (C) 2021 by Elasticsearch BV ( original distribution )

This is free software, licensed under:

The Apache License, Version 2.0, January 2004