Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/Migration.pm

raw
1 # Licensed to Elasticsearch B.V. under one or more contributor
2 # license agreements. See the NOTICE file distributed with
3 # this work for additional information regarding copyright
4 # ownership. Elasticsearch B.V. licenses this file to you under
5 # the Apache License, Version 2.0 (the "License"); you may
6 # not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing,
12 # software distributed under the License is distributed on an
13 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 # KIND, either express or implied. See the License for the
15 # specific language governing permissions and limitations
16 # under the License.
17
18 package Search::Elasticsearch::Client::8_0::Direct::Migration;
19 $Search::Elasticsearch::Client::8_0::Direct::Migration::VERSION = '8.12';
20 use Moo;
21 with 'Search::Elasticsearch::Client::8_0::Role::API';
22 with 'Search::Elasticsearch::Role::Client::Direct';
23 use namespace::clean;
24
25 __PACKAGE__->_install_api('migration');
26
27 1;
28
29 =pod
30
31 =encoding UTF-8
32
33 =head1 NAME
34
35 Search::Elasticsearch::Client::8_0::Direct::Migration - Plugin providing Migration API for Search::Elasticsearch 8.x
36
37 =head1 VERSION
38
39 version 8.12
40
41 =head1 SYNOPSIS
42
43 my $response = $es->migration->deprecations();
44
45 =head2 DESCRIPTION
46
47 This class extends the L<Search::Elasticsearch> client with a C<migration>
48 namespace, to support the API
49 L<Migration APIs|https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>.
50
51 =head1 METHODS
52
53 The full documentation for the Migration APIs is available here:
54 L<https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>
55
56 =head2 C<deprecations()>
57
58 $response = $es->migration->deprecations(
59 index => $index # optional
60 )
61
62 The C<deprecations()> API is to be used to retrieve information about different cluster, node,
63 and index level settings that use deprecated features that will be removed or changed in the
64 next major version.
65
66 See the L<deprecations docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html>
67 for more information.
68
69 Query string parameters:
70 C<error_trace>,
71 C<human>
72
73 =head2 C<get_assistance()>
74
75 $response = $es->migration->get_assistance(
76 index => $index | \@indices # optional
77 )
78
79 The C<get_assistance()> API analyzes existing indices in the cluster and returns the information
80 about indices that require some changes before the cluster can be upgraded to the next major version.
81
82 See the L<get_assistance docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html>
83 for more information.
84
85 Query string parameters:
86 C<allow_no_indices>,
87 C<error_trace>,
88 C<expand_wildcards>,
89 C<human>,
90 C<ignore_unavailable>
91
92 =head2 C<upgrade()>
93
94 $response = $es->migration->upgrade(
95 index => $index # required
96 )
97
98 The C<upgrade()> API performs the upgrade of internal indices to make them compatible with the
99 next major version.
100
101 See the L<upgrade() docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html>
102 for more information.
103
104 Query string parameters:
105 C<error_trace>,
106 C<human>,
107 C<wait_for_completion>
108
109 =head1 AUTHOR
110
111 Enrico Zimuel <[email protected]>
112
113 =head1 COPYRIGHT AND LICENSE
114
115 This software is Copyright (c) 2024 by Elasticsearch BV.
116
117 This is free software, licensed under:
118
119 The Apache License, Version 2.0, January 2004
120
121 =cut
122
123 __END__
124
125 # ABSTRACT: Plugin providing Migration API for Search::Elasticsearch 8.x
126