/ 
OpenSearch-Client-3.007004
/ OpenSearch::Client::Core::3_0::Direct::Tasks

NAME

OpenSearch::Client::Core::3_0::Direct::Tasks

VERSION

version 3.007004

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Tasks APIs

A task is any operation that you run in a cluster. For example, searching your data collection of books for a title or author name is a task. When you run OpenSearch, a task is automatically created to monitor your cluster's health and performance. For more information about all of the tasks currently executing in your cluster, you can use the tasks API operation.

See OpenSearch documentation for tasks.

METHODS

tasks->cancel

Cancels a task, if it can be cancelled through an API.

Paths served by this method:

POST /_tasks/_cancel
POST /_tasks/{task_id}/_cancel
$resp = $client->tasks->cancel(
    
     # path parameters
    
    'task_id'              =>  $task_id,   # optional
    
     # Endpoint specific query string parameters
    
    'actions'              =>  $qval1,     # list
    'nodes'                =>  $qval2,     # list
    'parent_task_id'       =>  $qval3,     # string
    'wait_for_completion'  =>  $qval4,     # boolean
    
     # 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 tasks.cancel

tasks->get

Returns information about a task.

Paths served by this method:

GET /_tasks/{task_id}
$resp = $client->tasks->get(
    
     # path parameters
    
    'task_id'              =>  $task_id,   # required
    
     # Endpoint specific query string parameters
    
    'timeout'              =>  $qval1,     # string
    'wait_for_completion'  =>  $qval2,     # boolean
    
     # 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 tasks.get

tasks->list

Returns a list of tasks.

Paths served by this method:

GET /_tasks
$resp = $client->tasks->list(
    
     # Endpoint specific query string parameters
    
    'actions'              =>  $qval1,     # list
    'detailed'             =>  $qval2,     # boolean
    'group_by'             =>  $qval3,     # string
    'nodes'                =>  $qval4,     # list
    'parent_task_id'       =>  $qval5,     # string
    'timeout'              =>  $qval6,     # string
    'wait_for_completion'  =>  $qval7,     # boolean
    
     # Common API query string parameters
    
    'error_trace'          =>  $qval8,     # boolean
    'filter_path'          =>  $qval9,     # list
    'human'                =>  $qval10,    # boolean
    'pretty'               =>  $qval11,    # boolean
    'source'               =>  $qval12,    # string
);

OpenSearch documentation for tasks.list

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