Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/License.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::License;
19 $Search::Elasticsearch::Client::8_0::Direct::License::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('license');
26
27 1;
28
29 =pod
30
31 =encoding UTF-8
32
33 =head1 NAME
34
35 Search::Elasticsearch::Client::8_0::Direct::License - Plugin providing License API for Search::Elasticsearch 8.x
36
37 =head1 VERSION
38
39 version 8.12
40
41 =head1 SYNOPSIS
42
43 my $response = $es->license->get();
44
45 =head2 DESCRIPTION
46
47 This class extends the L<Search::Elasticsearch> client with a C<license>
48 namespace, to support the API for the License plugin for Elasticsearch.
49
50 =head1 METHODS
51
52 The full documentation for the License plugin is available here:
53 L<https://www.elastic.co/guide/en/x-pack/current/license-management.html>
54
55 =head2 C<get()>
56
57 $response = $es->license->get()
58
59 The C<get()> method returns the currently installed license.
60
61 See the L<license.get docs|https://www.elastic.co/guide/en/x-pack/current/listing-licenses.html>
62 for more information.
63
64 Query string parameters:
65 C<error_trace>,
66 C<human>,
67 C<local>
68
69 =head2 C<post()>
70
71 $response = $es->license->post(
72 body => {...} # required
73 );
74
75 The C<post()> method adds or updates the license for the cluster. The C<body>
76 can be passed as JSON or as a string.
77
78 See the L<license.put docs|https://www.elastic.co/guide/en/x-pack/current/installing-license.html>
79 for more information.
80
81 Query string parameters:
82 C<acknowledge>,
83 C<error_trace>,
84 C<human>
85
86 =head2 C<get_basic_status()>
87
88 $response = $es->license->get_basic_status()
89
90 This API enables you to check the status of your basic license.
91
92 Query string parameters:
93 C<error_trace>,
94 C<filter_path>,
95 C<human>
96
97 See the L<get-basic-status docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html> for more.
98
99 =head2 C<post_start_basic()>
100
101 $response = $es->license->post_start_basic()
102
103 This API enables you to initiate an indefinite basic license, which gives access to all the basic features.
104
105 Query string parameters:
106 C<acknowledge>,
107 C<error_trace>,
108 C<filter_path>,
109 C<human>
110
111 See the L<post-start-basic docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/start-basic.html> for more.
112
113 =head2 C<get_trial_status()>
114
115 $response = $es->license->get_trial_status()
116
117 This API enables you to check the status of your trial license.
118
119 Query string parameters:
120 C<error_trace>,
121 C<filter_path>,
122 C<human>
123
124 See the L<get-trial-status docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trial-status.html> for more.
125
126 =head2 C<post_start_trial()>
127
128 $response = $es->license->post_start_trial()
129
130 This API enables you to upgrade from a basic license to a 30-day trial license, which gives
131 access to the platinum features.
132
133 Query string parameters:
134 C<acknowledge>,
135 C<error_trace>,
136 C<filter_path>,
137 C<human>
138
139 See the L<post-start-trial docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html> for more.
140
141 =head1 AUTHOR
142
143 Enrico Zimuel <[email protected]>
144
145 =head1 COPYRIGHT AND LICENSE
146
147 This software is Copyright (c) 2024 by Elasticsearch BV.
148
149 This is free software, licensed under:
150
151 The Apache License, Version 2.0, January 2004
152
153 =cut
154
155 __END__
156
157 # ABSTRACT: Plugin providing License API for Search::Elasticsearch 8.x
158