# Licensed to Elasticsearch B.V. under one or more contributor # license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright # ownership. Elasticsearch B.V. licenses this file to you under # the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. package Search::Elasticsearch::Client::8_0::Direct::CCR; $Search::Elasticsearch::Client::8_0::Direct::CCR::VERSION = '8.12'; use Moo; with 'Search::Elasticsearch::Client::8_0::Role::API'; with 'Search::Elasticsearch::Role::Client::Direct'; use Search::Elasticsearch::Util qw(parse_params); use namespace::clean; __PACKAGE__->_install_api('ccr'); 1; =pod =encoding UTF-8 =head1 NAME Search::Elasticsearch::Client::8_0::Direct::CCR - Plugin providing cross-cluster replication APIs for Search::Elasticsearch 8.x =head1 VERSION version 8.12 =head2 DESCRIPTION This module provides methods to use the cross-cluster replication feature. The full documentation for CCR is available here: L =head1 FOLLOW METHODS =head2 C $response = $es->ccr->follow( index => $index, # required body => {...} # required ) The C method creates a new follower index that is configured to follow the referenced leader index. Query string parameters: C, C, C, C See the L for more information. =head2 C $response = $es->ccr->pause_follow( index => $index, # required ) The C method pauses following of an index. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ccr->resume_follow( index => $index, # required ) The C method resumes following of an index. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ccr->unfollow( index => $index, # required ) The C method converts a follower index into a normal index. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ccr->forget_follower( index => $index, # required ) The C method removes the follower retention leases from the leader. Query string parameters: C, C, C See the L for more information. =head1 STATS METHODS =head2 C $response = $es->ccr->stats() The C method returns all stats related to cross-cluster replication. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ccr->follow_stats( index => $index | \@indices, # optional ) The C method returns shard-level stats about follower indices. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ccr->follow_info( index => $index | \@indices, # optional ) The C method returns the parameters and the status for each follower index. Query string parameters: C, C, C See the L for more information. =head1 AUTO-FOLLOW METHODS =head2 C $response = $es->ccr->put_auto_follow_pattern( name => $name # required ) The C method creates a new named collection of auto-follow patterns against the remote cluster specified in the request body. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ccr->get_auto_follow_pattern( name => $name # optional ) The C method retrieves a named collection of auto-follow patterns, or all patterns. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ccr->delete_auto_follow_pattern( name => $name # required ) The C method deletes a named collection of auto-follow patterns. Query string parameters: C, C, C See the L for more information. =head1 AUTHOR Enrico Zimuel =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2024 by Elasticsearch BV. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut __END__ # ABSTRACT: Plugin providing cross-cluster replication APIs for Search::Elasticsearch 8.x