Files
opensearch-pyd/elasticsearch/_async/client/license.py
T

99 lines
3.8 KiB
Python

# Licensed to Elasticsearch B.V under one or more agreements.
# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
# See the LICENSE file in the project root for more information
from .utils import NamespacedClient, query_params
class LicenseClient(NamespacedClient):
@query_params()
def delete(self, params=None, headers=None):
"""
Deletes licensing information for the cluster
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html>`_
"""
return self.transport.perform_request(
"DELETE", "/_license", params=params, headers=headers
)
@query_params("accept_enterprise", "local")
def get(self, params=None, headers=None):
"""
Retrieves licensing information for the cluster
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html>`_
:arg accept_enterprise: Supported for backwards compatibility
with 7.x. If this param is used it must be set to true
:arg local: Return local information, do not retrieve the state
from master node (default: false)
"""
return self.transport.perform_request(
"GET", "/_license", params=params, headers=headers
)
@query_params()
def get_basic_status(self, params=None, headers=None):
"""
Retrieves information about the status of the basic license.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html>`_
"""
return self.transport.perform_request(
"GET", "/_license/basic_status", params=params, headers=headers
)
@query_params()
def get_trial_status(self, params=None, headers=None):
"""
Retrieves information about the status of the trial license.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html>`_
"""
return self.transport.perform_request(
"GET", "/_license/trial_status", params=params, headers=headers
)
@query_params("acknowledge")
def post(self, body=None, params=None, headers=None):
"""
Updates the license for the cluster.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html>`_
:arg body: licenses to be installed
:arg acknowledge: whether the user has acknowledged acknowledge
messages (default: false)
"""
return self.transport.perform_request(
"PUT", "/_license", params=params, headers=headers, body=body
)
@query_params("acknowledge")
def post_start_basic(self, params=None, headers=None):
"""
Starts an indefinite basic license.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html>`_
:arg acknowledge: whether the user has acknowledged acknowledge
messages (default: false)
"""
return self.transport.perform_request(
"POST", "/_license/start_basic", params=params, headers=headers
)
@query_params("acknowledge", "doc_type")
def post_start_trial(self, params=None, headers=None):
"""
starts a limited time trial license.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html>`_
:arg acknowledge: whether the user has acknowledged acknowledge
messages (default: false)
:arg doc_type: The type of trial license to generate (default:
"trial")
"""
# type is a reserved word so it cannot be used, use doc_type instead
if "doc_type" in params:
params["type"] = params.pop("doc_type")
return self.transport.perform_request(
"POST", "/_license/start_trial", params=params, headers=headers
)