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

NAME

OpenSearch::Client::Core::3_0::Direct::WLM

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Workload Management

Workload management allows you to group search traffic and isolate network resources, preventing the overuse of network resources by specific requests.

See OpenSearch documentation for wlm.

METHODS

create_query_group

Creates a new query group and sets the resource limits for the new query group.

Paths served by this method:

PUT /_wlm/query_group

Method added in OpenSearch version 2.17

$resp = $client->wlm->create_query_group(
    
    'body'         =>  $body,      # optional
    
     # 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 wlm->create_query_group

delete_query_group

Deletes the specified query group.

Paths served by this method:

DELETE /_wlm/query_group/{name}

Method added in OpenSearch version 2.17

$resp = $client->wlm->delete_query_group(
    
     # path parameters
    
    'name'         =>  $name,      # 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 wlm->delete_query_group

get_query_group

Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved.

Paths served by this method:

GET /_wlm/query_group
GET /_wlm/query_group/{name}

Method added in OpenSearch version 2.17

$resp = $client->wlm->get_query_group(
    
     # path parameters
    
    'name'         =>  $name,      # optional
    
     # 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 wlm->get_query_group

update_query_group

Updates the specified query group.

Paths served by this method:

PUT /_wlm/query_group/{name}

Method added in OpenSearch version 2.17

$resp = $client->wlm->update_query_group(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'name'         =>  $name,      # 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 wlm->update_query_group

method_supported_in_version

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

my $boolean = $os->wlm->method_supported_in_version(
    method  => 'create_query_group',
    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