NAME

OpenSearch::Client::Core::3_0::Direct::ISM

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Index State Management

Use the index state management operations to programmatically work with policies and managed indexes.

See OpenSearch documentation for ism.

METHODS

add_policy

Adds a policy to an index.

Paths served by this method:

POST /_plugins/_ism/add
POST /_plugins/_ism/add/{index}

Method added in OpenSearch version 1.0

$resp = $client->ism->add_policy(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'index'        =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'index'        =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for ism->add_policy

change_policy

Updates the managed index policy to a new policy.

Paths served by this method:

POST /_plugins/_ism/change_policy
POST /_plugins/_ism/change_policy/{index}

Method added in OpenSearch version 1.0

$resp = $client->ism->change_policy(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'index'        =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'index'        =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for ism->change_policy

delete_policy

Deletes a policy.

Paths served by this method:

DELETE /_plugins/_ism/policies/{policy_id}

Method added in OpenSearch version 1.0

$resp = $client->ism->delete_policy(
    
     # path parameters
    
    'policy_id'    =>  $policy_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 ism->delete_policy

exists_policy

Checks for the existence of a policy.

Paths served by this method:

HEAD /_plugins/_ism/policies/{policy_id}

Method added in OpenSearch version 1.0

$resp = $client->ism->exists_policy(
    
     # path parameters
    
    'policy_id'    =>  $policy_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 ism->exists_policy

explain_policy

Retrieves the currently applied policy on the specified indexes.

Paths served by this method:

GET /_plugins/_ism/explain
GET /_plugins/_ism/explain/{index}
POST /_plugins/_ism/explain
POST /_plugins/_ism/explain/{index}

Method added in OpenSearch version 1.0

$resp = $client->ism->explain_policy(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'index'        =>  $index,     # 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 ism->explain_policy

get_policies

Retrieves the policies.

Paths served by this method:

GET /_plugins/_ism/policies

Method added in OpenSearch version 1.0

$resp = $client->ism->get_policies(
    
     # 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 ism->get_policies

get_policy

Retrieves a specific policy.

Paths served by this method:

GET /_plugins/_ism/policies/{policy_id}

Method added in OpenSearch version 1.0

$resp = $client->ism->get_policy(
    
     # path parameters
    
    'policy_id'    =>  $policy_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 ism->get_policy

put_policies

Creates or updates policies.

Paths served by this method:

PUT /_plugins/_ism/policies

Method added in OpenSearch version 1.0

$resp = $client->ism->put_policies(
    
    'body'             =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'if_primary_term'  =>  $qval1,     # number
    'if_seq_no'        =>  $qval2,     # number
    'policyID'         =>  $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 ism->put_policies

put_policy

Creates or updates a policy.

Paths served by this method:

PUT /_plugins/_ism/policies/{policy_id}

Method added in OpenSearch version 1.0

$resp = $client->ism->put_policy(
    
    'body'             =>  $body,      # optional
    
     # path parameters
    
    'policy_id'        =>  $policy_id,  # required
    
     # Endpoint specific query string parameters
    
    'if_primary_term'  =>  $qval1,     # number
    'if_seq_no'        =>  $qval2,     # number
    
     # 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 ism->put_policy

refresh_search_analyzers

Refreshes search analyzers in real time.

Paths served by this method:

POST /_plugins/_refresh_search_analyzers/{index}

Method added in OpenSearch version 1.0

$resp = $client->ism->refresh_search_analyzers(
    
     # path parameters
    
    'index'        =>  $index,     # 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 ism->refresh_search_analyzers

remove_policy

Removes a policy from an index.

Paths served by this method:

POST /_plugins/_ism/remove
POST /_plugins/_ism/remove/{index}

Method added in OpenSearch version 1.0

$resp = $client->ism->remove_policy(
    
     # path parameters
    
    'index'        =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'index'        =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for ism->remove_policy

retry_index

Retries the failed action for an index.

Paths served by this method:

POST /_plugins/_ism/retry
POST /_plugins/_ism/retry/{index}

Method added in OpenSearch version 1.0

$resp = $client->ism->retry_index(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'index'        =>  $index,     # optional
    
     # Endpoint specific query string parameters
    
    'index'        =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for ism->retry_index

method_supported_in_version

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

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

Both method and version are required.

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

To install OpenSearch::Client, copy and paste the appropriate command in to your terminal.

cpanm

cpanm OpenSearch::Client

CPAN shell

perl -MCPAN -e shell
install OpenSearch::Client

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

METHODS

add_policy

change_policy

delete_policy

exists_policy

explain_policy

get_policies

get_policy

put_policies

put_policy

refresh_search_analyzers

remove_policy

retry_index

method_supported_in_version

MANUAL

HISTORY

AUTHOR

CREDITS

COPYRIGHT AND LICENSE

Module Install Instructions

Keyboard Shortcuts