Adding X-Pack clients to -py repo (elastic#748)

Author: fxdgear

elasticsearch/client/__init__.py

@@ -12,6 +12,7 @@
 from .remote import RemoteClient
 from .snapshot import SnapshotClient
 from .tasks import TasksClient
+from .xpack import XPackClient
 from .utils import query_params, _make_path, SKIP_IN_PATH
 
 logger = logging.getLogger('elasticsearch')
@@ -195,6 +196,7 @@ def __init__(self, hosts=None, transport_class=Transport, **kwargs):
         self.remote = RemoteClient(self)
         self.snapshot = SnapshotClient(self)
         self.tasks = TasksClient(self)
+        self.xpack = XPackClient(self)
 
     def __repr__(self):
         try:

elasticsearch/client/xpack/__init__.py

@@ -0,0 +1,47 @@
+from elasticsearch.client.utils import NamespacedClient, query_params
+
+from .graph import GraphClient
+from .license import LicenseClient
+from .monitoring import MonitoringClient
+from .security import SecurityClient
+from .watcher import WatcherClient
+from .ml import MlClient
+from .migration import MigrationClient
+from .deprecation import DeprecationClient
+
+class XPackClient(NamespacedClient):
+    namespace = 'xpack'
+
+    def __init__(self, *args, **kwargs):
+        super(XPackClient, self).__init__(*args, **kwargs)
+        self.graph = GraphClient(self.client)
+        self.license = LicenseClient(self.client)
+        self.monitoring = MonitoringClient(self.client)
+        self.security = SecurityClient(self.client)
+        self.watcher = WatcherClient(self.client)
+        self.ml = MlClient(self.client)
+        self.migration = MigrationClient(self.client)
+        self.deprecation = DeprecationClient(self.client)
+
+    @query_params('categories', 'human')
+    def info(self, params=None):
+        """
+        Retrieve information about xpack, including build number/timestamp and license status
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html>`_
+
+        :arg categories: Comma-separated list of info categories. Can be any of:
+            build, license, features
+        :arg human: Presents additional info for humans (feature descriptions
+            and X-Pack tagline)
+        """
+        return self.transport.perform_request('GET', '/_xpack', params=params)
+
+    @query_params('master_timeout')
+    def usage(self, params=None):
+        """
+        Retrieve information about xpack features usage
+
+        :arg master_timeout: Specify timeout for watch write operation
+        """
+        return self.transport.perform_request('GET', '/_xpack/usage',
+            params=params)

elasticsearch/client/xpack/deprecation.py

@@ -0,0 +1,13 @@
+from elasticsearch.client.utils import NamespacedClient, query_params, _make_path
+
+class DeprecationClient(NamespacedClient):
+    @query_params()
+    def info(self, index=None, params=None):
+        """
+        `<http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html>`_
+
+        :arg index: Index pattern
+        """
+        return self.transport.perform_request('GET', _make_path(index, '_xpack',
+            'migration', 'deprecations'), params=params)
+

elasticsearch/client/xpack/graph.py

@@ -0,0 +1,18 @@
+from elasticsearch.client.utils import NamespacedClient, query_params, _make_path
+
+class GraphClient(NamespacedClient):
+    @query_params('routing', 'timeout')
+    def explore(self, index=None, doc_type=None, body=None, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html>`_
+
+        :arg index: A comma-separated list of index names to search; use `_all`
+            or empty string to perform the operation on all indices
+        :arg doc_type: A comma-separated list of document types to search; leave
+            empty to perform the operation on all types
+        :arg body: Graph Query DSL
+        :arg routing: Specific routing value
+        :arg timeout: Explicit operation timeout
+        """
+        return self.transport.perform_request('GET', _make_path(index, doc_type,
+            '_xpack', 'graph', '_explore'), params=params, body=body)

elasticsearch/client/xpack/license.py

@@ -0,0 +1,37 @@
+from elasticsearch.client.utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
+
+class LicenseClient(NamespacedClient):
+    @query_params()
+    def delete(self, params=None):
+        """
+
+        `<https://www.elastic.co/guide/en/x-pack/current/license-management.html>`_
+        """
+        return self.transport.perform_request('DELETE', '/_xpack/license',
+            params=params)
+
+    @query_params('local')
+    def get(self, params=None):
+        """
+
+        `<https://www.elastic.co/guide/en/x-pack/current/license-management.html>`_
+
+        :arg local: Return local information, do not retrieve the state from
+            master node (default: false)
+        """
+        return self.transport.perform_request('GET', '/_xpack/license',
+            params=params)
+
+    @query_params('acknowledge')
+    def post(self, body=None, params=None):
+        """
+
+        `<https://www.elastic.co/guide/en/x-pack/current/license-management.html>`_
+
+        :arg body: licenses to be installed
+        :arg acknowledge: whether the user has acknowledged acknowledge messages
+            (default: false)
+        """
+        return self.transport.perform_request('PUT', '/_xpack/license',
+            params=params, body=body)
+

elasticsearch/client/xpack/migration.py

@@ -0,0 +1,36 @@
+from elasticsearch.client.utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
+
+class MigrationClient(NamespacedClient):
+    @query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable')
+    def get_assistance(self, index=None, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html>`_
+
+        :arg index: A comma-separated list of index names; use `_all` or empty
+            string to perform the operation on all indices
+        :arg allow_no_indices: Whether to ignore if a wildcard indices
+            expression resolves into no concrete indices. (This includes `_all`
+            string or when no indices have been specified)
+        :arg expand_wildcards: Whether to expand wildcard expression to concrete
+            indices that are open, closed or both., default 'open', valid
+            choices are: 'open', 'closed', 'none', 'all'
+        :arg ignore_unavailable: Whether specified concrete indices should be
+            ignored when unavailable (missing or closed)
+        """
+        return self.transport.perform_request('GET', _make_path('_xpack',
+            'migration', 'assistance', index), params=params)
+
+    @query_params('wait_for_completion')
+    def upgrade(self, index, params=None):
+        """
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html>`_
+
+        :arg index: The name of the index
+        :arg wait_for_completion: Should the request block until the upgrade
+            operation is completed, default True
+        """
+        if index in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for a required argument 'index'.")
+        return self.transport.perform_request('POST', _make_path('_xpack',
+            'migration', 'upgrade', index), params=params)