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

NAME

OpenSearch::Client::Core::3_0::Direct::Ingestion

VERSION

version 3.007002

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Pull-based Ingestion Management

Pull-based ingestion enables OpenSearch to ingest data from streaming sources such as Apache Kafka or Amazon Kinesis. Unlike traditional ingestion methods where clients actively push data to OpenSearch through REST APIs, pull-based ingestion allows OpenSearch to control the data flow by retrieving data directly from streaming sources. This approach provides native backpressure handling, helping prevent server overload during traffic spikes. Pull-based ingestion guarantees at-least-once ingestion semantics and uses external versioning to ensure data consistency.

See OpenSearch documentation for ingestion.

METHODS

ingestion->get_state

Use this API to retrieve the ingestion state for a given index.

Paths served by this method:

GET /{index}/ingestion/_state
$resp = $client->ingestion->get_state(
    
     # path parameters
    
    'index'        =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'next_token'   =>  $qval1,     # string
    'size'         =>  $qval2,     # number
    '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 ingestion.get_state

ingestion->pause

Use this API to pause ingestion for a given index.

Paths served by this method:

POST /{index}/ingestion/_pause
$resp = $client->ingestion->pause(
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    '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 ingestion.pause

ingestion->resume

Use this API to resume ingestion for the given index.

Paths served by this method:

POST /{index}/ingestion/_resume
$resp = $client->ingestion->resume(
    
    'body'                     =>  $body,      # optional
    
     # path parameters
    
    'index'                    =>  $index,     # required
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    '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 ingestion.resume

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