view release on metacpan or  search on metacpan

lib/OpenSearch/Client/Core/3_0/Direct/Ingestion.pm  view on Meta::CPAN

# NOTICE file distributed with this work.
#
#-----------------------------------------------------------------------
# OpenSearch::Client
#-----------------------------------------------------------------------
# Copyright 2026 Mark Dootson
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

package OpenSearch::Client::Core::3_0::Direct::Ingestion;
$OpenSearch::Client::Core::3_0::Direct::Ingestion::VERSION = '3.007008';
use Moo;
with 'OpenSearch::Client::Core::3_0::Role::API';
with 'OpenSearch::Client::Role::Client::Direct';
use namespace::clean;

__PACKAGE__->_install_api('ingestion');

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

B<OpenSearch::Client::Core::3_0::Direct::Ingestion>

=head1 VERSION

version 3.007008

=head1 SYNOPSIS

  use OpenSearch::Client;
  
  my $client = OpenSearch::Client->new( ... );
  
  my $response = $client->ingestion-><methodname>(
    valone => $value1,
    valtwo => $value2
  );

=head1 DESCRIPTION

B<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 O...

L<See OpenSearch documentation for ingestion.|https://docs.opensearch.org/latest/api-reference/document-apis/pull-based-ingestion/>

=head1 METHODS
    
=head2 get_state

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

I<Paths served by this method:>

=over

=item
C<GET /{index}/ingestion/_state>

=back

I<Method added in OpenSearch version 3.1>


    $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
    );

L<OpenSearch documentation for ingestion-E<gt>get_state|https://docs.opensearch.org/docs/latest/api-reference/document-apis/pull-based-ingestion-management/>
    
=head2 pause

Use this API to pause ingestion for a given index.

I<Paths served by this method:>

=over

=item
C<POST /{index}/ingestion/_pause>

=back

I<Method added in OpenSearch version 3.1>