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