/ 
OpenSearch-Client-3.007009
/ OpenSearch::Client::Core::3_0::Direct::AsyncSearch

NAME

OpenSearch::Client::Core::3_0::Direct::AsyncSearch

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Asynchronous Search

Searching large volumes of data can take a long time, especially if you're searching across warm nodes or multiple remote clusters. Asynchronous search in OpenSearch lets you send search requests that run in the background. You can monitor the progress of these searches and get back partial results as they become available. After the search finishes, you can save the results to examine at a later time.'

See OpenSearch documentation for asynchronous_search.

METHODS

delete

Deletes any responses from an asynchronous search.

Paths served by this method:

DELETE /_plugins/_asynchronous_search/{id}

Method added in OpenSearch version 1.0

$resp = $client->asynchronous_search->delete(
    
     # path parameters
    
    'id'           =>  $id,        # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for asynchronous_search->delete

get

Gets partial responses from an asynchronous search.

Paths served by this method:

GET /_plugins/_asynchronous_search/{id}

Method added in OpenSearch version 1.0

$resp = $client->asynchronous_search->get(
    
     # path parameters
    
    'id'           =>  $id,        # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for asynchronous_search->get

Performs an asynchronous search.

Paths served by this method:

POST /_plugins/_asynchronous_search

Method added in OpenSearch version 1.0

$resp = $client->asynchronous_search->search(
    
    'body'                         =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'index'                        =>  $qval1,     # string
    'keep_alive'                   =>  $qval2,     # string
    'keep_on_completion'           =>  $qval3,     # boolean
    'wait_for_completion_timeout'  =>  $qval4,     # string
    
     # Common API query string parameters
    
    'error_trace'                  =>  $qval5,     # boolean
    'filter_path'                  =>  $qval6,     # list
    'human'                        =>  $qval7,     # boolean
    'pretty'                       =>  $qval8,     # boolean
    'source'                       =>  $qval9,     # string
);

OpenSearch documentation for asynchronous_search->search

stats

Monitors any asynchronous searches that are `running`, `completed`, or `persisted`.

Paths served by this method:

GET /_plugins/_asynchronous_search/stats

Method added in OpenSearch version 1.0

$resp = $client->asynchronous_search->stats(
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for asynchronous_search->stats

method_supported_in_version

Return whether a method in this module namespace is supported for an OpenSearch server version

my $boolean = $os->asynchronous_search->method_supported_in_version(
    method  => 'delete',
    version => '2.4.0'
);

Both method and version are required.

See also global_method_supported_in_version

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