X-Pack

class elasticsearch.client.XPackClient(client)
Parameters:

client (BaseClient) –

info(*, accept_enterprise=None, categories=None, error_trace=None, filter_path=None, human=None, pretty=None)

Retrieves information about the installed X-Pack features.

https://www.elastic.co/guide/en/elasticsearch/reference/master/info-api.html

Parameters:
  • accept_enterprise (bool | None) – If this param is used it must be set to true

  • categories (Sequence[str] | None) – A comma-separated list of the information categories to include in the response. For example, build,license,features.

  • error_trace (bool | None) –

  • filter_path (str | Sequence[str] | None) –

  • human (bool | None) –

  • pretty (bool | None) –

Return type:

ObjectApiResponse[Any]

usage(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

Retrieves usage information about the installed X-Pack features.

https://www.elastic.co/guide/en/elasticsearch/reference/master/usage-api.html

Parameters:
  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  • error_trace (bool | None) –

  • filter_path (str | Sequence[str] | None) –

  • human (bool | None) –

  • pretty (bool | None) –

Return type:

ObjectApiResponse[Any]