NAME
OpenSearch::Client::Core::3_0::Direct::Replication
VERSION
version 3.007009
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->replication-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Cross-cluster replication
Use these replication operations to programmatically manage cross-cluster replication.
See OpenSearch documentation for replication.
METHODS
autofollow_stats
Retrieves information about any auto-follow activity and any replication rules configured on the specified cluster.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->autofollow_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 replication->autofollow_stats
create_replication_rule
Automatically starts the replication on indexes matching a specified pattern.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->create_replication_rule(
'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 replication->create_replication_rule
delete_replication_rule
Deletes the specified replication rule.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->delete_replication_rule(
'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 replication->delete_replication_rule
follower_stats
Retrieves information about any follower (syncing) indexes on a specified cluster.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->follower_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 replication->follower_stats
leader_stats
Retrieves information about any replicated leader indexes on a specified cluster.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->leader_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 replication->leader_stats
pause
Pauses the replication of the leader index.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->pause(
'body' => $body, # optional
# 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 replication->pause
resume
Resumes replication of the leader index.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->resume(
'body' => $body, # optional
# 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 replication->resume
start
Initiates the replication of an index from the leader cluster to the follower cluster.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->start(
'body' => $body, # optional
# 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 replication->start
status
Retrieves the the status of an index replication.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->status(
# 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 replication->status
stop
Terminates the replication and converts the follower index to a standard index.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->stop(
'body' => $body, # optional
# 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 replication->stop
update_settings
Updates any settings on the follower index.
Paths served by this method:
Method added in OpenSearch version 1.1
$resp = $client->replication->update_settings(
'body' => $body, # optional
# 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 replication->update_settings
method_supported_in_version
Return whether a method in this module namespace is supported for an OpenSearch server version
my $boolean = $os->replication->method_supported_in_version(
method => 'autofollow_stats',
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