1Search::Elasticsearch::UCsleSireeanCrtoc:nh:t:8r:_iE0bl:ua:tsDetidircePsceetra:lr:cLDhio:cc:euCnmlseiene(tn3at)t:i:o8n_0::Direct::License(3)
2
3
4

NAME

6       Search::Elasticsearch::Client::8_0::Direct::License - Plugin providing
7       License API for Search::Elasticsearch 8.x
8

VERSION

10       version 8.00
11

SYNOPSIS

13           my $response = $es->license->get();
14
15   DESCRIPTION
16       This class extends the Search::Elasticsearch client with a "license"
17       namespace, to support the API for the License plugin for Elasticsearch.
18

METHODS

20       The full documentation for the License plugin is available here:
21       <https://www.elastic.co/guide/en/x-pack/current/license-management.html>
22
23   get()
24           $response = $es->license->get()
25
26       The get() method returns the currently installed license.
27
28       See the license.get docs <https://www.elastic.co/guide/en/x-
29       pack/current/listing-licenses.html> for more information.
30
31       Query string parameters:
32           "error_trace",
33           "human",
34           "local"
35
36   post()
37           $response = $es->license->post(
38               body     => {...}          # required
39           );
40
41       The post() method adds or updates the license for the cluster. The
42       "body" can be passed as JSON or as a string.
43
44       See the license.put docs <https://www.elastic.co/guide/en/x-
45       pack/current/installing-license.html> for more information.
46
47       Query string parameters:
48           "acknowledge",
49           "error_trace",
50           "human"
51
52   get_basic_status()
53           $response = $es->license->get_basic_status()
54
55       This API enables you to check the status of your basic license.
56
57       Query string parameters:
58           "error_trace",
59           "filter_path",
60           "human"
61
62       See the get-basic-status docs
63       <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-
64       basic-status.html> for more.
65
66   post_start_basic()
67           $response = $es->license->post_start_basic()
68
69       This API enables you to  initiate an indefinite basic license, which
70       gives access to all the basic features.
71
72       Query string parameters:
73           "acknowledge",
74           "error_trace",
75           "filter_path",
76           "human"
77
78       See the post-start-basic docs
79       <https://www.elastic.co/guide/en/elasticsearch/reference/current/start-
80       basic.html> for more.
81
82   get_trial_status()
83           $response = $es->license->get_trial_status()
84
85       This API enables you to check the status of your trial license.
86
87       Query string parameters:
88           "error_trace",
89           "filter_path",
90           "human"
91
92       See the get-trial-status docs
93       <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-
94       trial-status.html> for more.
95
96   post_start_trial()
97           $response = $es->license->post_start_trial()
98
99       This API enables you to upgrade from a basic license to a 30-day trial
100       license, which gives access to the platinum features.
101
102       Query string parameters:
103           "acknowledge",
104           "error_trace",
105           "filter_path",
106           "human"
107
108       See the post-start-trial docs
109       <https://www.elastic.co/guide/en/elasticsearch/reference/current/start-
110       trial.html> for more.
111

AUTHOR

113       Enrico Zimuel <enrico.zimuel@elastic.co>
114

116       This software is Copyright (c) 2022 by Elasticsearch BV.
117
118       This is free software, licensed under:
119
120         The Apache License, Version 2.0, January 2004
121
122
123
124perl v5.36.0            Search::El2a0s2t3i-c0s1e-a2r0ch::Client::8_0::Direct::License(3)
Impressum