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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
# 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.
import typing as t
from elastic_transport import ObjectApiResponse
from ._base import NamespacedClient
from .utils import _rewrite_parameters
class LicenseClient(NamespacedClient):
@_rewrite_parameters()
def delete(
self,
*,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Delete the license.</p>
<p>When the license expires, your subscription level reverts to Basic.</p>
<p>If the operator privileges feature is enabled, only operator users can use this API.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-delete>`_
:param master_timeout: The period to wait for a connection to the master node.
:param timeout: The period to wait for a response. If no response is received
before the timeout expires, the request fails and returns an error.
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_license"
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"DELETE",
__path,
params=__query,
headers=__headers,
endpoint_id="license.delete",
path_parts=__path_parts,
)
@_rewrite_parameters()
def get(
self,
*,
accept_enterprise: t.Optional[bool] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
local: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Get license information.</p>
<p>Get information about your Elastic license including its type, its status, when it was issued, and when it expires.</p>
<blockquote>
<p>info
If the master node is generating a new cluster state, the get license API may return a <code>404 Not Found</code> response.
If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.</p>
</blockquote>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get>`_
:param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise
license types. If `false`, this parameter returns platinum for both platinum
and enterprise license types. This behavior is maintained for backwards compatibility.
This parameter is deprecated and will always be set to true in 8.x.
:param local: Specifies whether to retrieve local information. The default value
is `false`, which means the information is retrieved from the master node.
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_license"
__query: t.Dict[str, t.Any] = {}
if accept_enterprise is not None:
__query["accept_enterprise"] = accept_enterprise
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if local is not None:
__query["local"] = local
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"GET",
__path,
params=__query,
headers=__headers,
endpoint_id="license.get",
path_parts=__path_parts,
)
@_rewrite_parameters()
def get_basic_status(
self,
*,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Get the basic license status.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-basic-status>`_
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_license/basic_status"
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"GET",
__path,
params=__query,
headers=__headers,
endpoint_id="license.get_basic_status",
path_parts=__path_parts,
)
@_rewrite_parameters()
def get_trial_status(
self,
*,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Get the trial status.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-trial-status>`_
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_license/trial_status"
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"GET",
__path,
params=__query,
headers=__headers,
endpoint_id="license.get_trial_status",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("license", "licenses"),
)
def post(
self,
*,
acknowledge: t.Optional[bool] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
license: t.Optional[t.Mapping[str, t.Any]] = None,
licenses: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the license.</p>
<p>You can update your license at runtime without shutting down your nodes.
License updates take effect immediately.
If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.
You must then re-submit the API request with the acknowledge parameter set to true.</p>
<p>NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.
If the operator privileges feature is enabled, only operator users can use this API.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post>`_
:param acknowledge: Specifies whether you acknowledge the license changes.
:param license:
:param licenses: A sequence of one or more JSON documents containing the license
information.
:param master_timeout: The period to wait for a connection to the master node.
:param timeout: The period to wait for a response. If no response is received
before the timeout expires, the request fails and returns an error.
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_license"
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if acknowledge is not None:
__query["acknowledge"] = acknowledge
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
if not __body:
if license is not None:
__body["license"] = license
if licenses is not None:
__body["licenses"] = licenses
if not __body:
__body = None # type: ignore[assignment]
__headers = {"accept": "application/json"}
if __body is not None:
__headers["content-type"] = "application/json"
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="license.post",
path_parts=__path_parts,
)
@_rewrite_parameters()
def post_start_basic(
self,
*,
acknowledge: t.Optional[bool] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Start a basic license.</p>
<p>Start an indefinite basic license, which gives access to all the basic features.</p>
<p>NOTE: In order to start a basic license, you must not currently have a basic license.</p>
<p>If the basic license does not support all of the features that are available with your current license, however, you are notified in the response.
You must then re-submit the API request with the <code>acknowledge</code> parameter set to <code>true</code>.</p>
<p>To check the status of your basic license, use the get basic license API.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-basic>`_
:param acknowledge: whether the user has acknowledged acknowledge messages (default:
false)
:param master_timeout: Period to wait for a connection to the master node.
:param timeout: Period to wait for a response. If no response is received before
the timeout expires, the request fails and returns an error.
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_license/start_basic"
__query: t.Dict[str, t.Any] = {}
if acknowledge is not None:
__query["acknowledge"] = acknowledge
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"POST",
__path,
params=__query,
headers=__headers,
endpoint_id="license.post_start_basic",
path_parts=__path_parts,
)
@_rewrite_parameters()
def post_start_trial(
self,
*,
acknowledge: t.Optional[bool] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
type: t.Optional[str] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Start a trial.
Start a 30-day trial, which gives access to all subscription features.</p>
<p>NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.
For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at <a href="https://www.elastic.co/trialextension">https://www.elastic.co/trialextension</a>.</p>
<p>To check the status of your trial, use the get trial status API.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-trial>`_
:param acknowledge: whether the user has acknowledged acknowledge messages (default:
false)
:param master_timeout: Period to wait for a connection to the master node.
:param type: The type of trial license to generate (default: "trial")
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_license/start_trial"
__query: t.Dict[str, t.Any] = {}
if acknowledge is not None:
__query["acknowledge"] = acknowledge
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if type is not None:
__query["type"] = type
__headers = {"accept": "application/json"}
return self.perform_request( # type: ignore[return-value]
"POST",
__path,
params=__query,
headers=__headers,
endpoint_id="license.post_start_trial",
path_parts=__path_parts,
)
|
