Generated API

elasticsearch/client/transform.py

@@ -0,0 +1,166 @@
+from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
+
+
+class TransformClient(NamespacedClient):
+    @query_params("force")
+    def delete_transform(self, transform_id, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html>`_
+
+        :arg transform_id: The id of the transform to delete
+        :arg force: When `true`, the transform is deleted regardless of
+            its current state. The default value is `false`, meaning that the
+            transform must be `stopped` before it can be deleted.
+        """
+        if transform_id in SKIP_IN_PATH:
+            raise ValueError(
+                "Empty value passed for a required argument 'transform_id'."
+            )
+
+        return self.transport.perform_request(
+            "DELETE", _make_path("_transform", transform_id), params=params
+        )
+
+    @query_params("allow_no_match", "from_", "size")
+    def get_transform(self, transform_id=None, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html>`_
+
+        :arg transform_id: The id or comma delimited list of id
+            expressions of the transforms to get, '_all' or '*' implies get all
+            transforms
+        :arg allow_no_match: Whether to ignore if a wildcard expression
+            matches no transforms. (This includes `_all` string or when no
+            transforms have been specified)
+        :arg from_: skips a number of transform configs, defaults to 0
+        :arg size: specifies a max number of transforms to get, defaults
+            to 100
+        """
+        # from is a reserved word so it cannot be used, use from_ instead
+        if "from_" in params:
+            params["from"] = params.pop("from_")
+
+        return self.transport.perform_request(
+            "GET", _make_path("_transform", transform_id), params=params
+        )
+
+    @query_params("allow_no_match", "from_", "size")
+    def get_transform_stats(self, transform_id, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html>`_
+
+        :arg transform_id: The id of the transform for which to get
+            stats. '_all' or '*' implies all transforms
+        :arg allow_no_match: Whether to ignore if a wildcard expression
+            matches no transforms. (This includes `_all` string or when no
+            transforms have been specified)
+        :arg from_: skips a number of transform stats, defaults to 0
+        :arg size: specifies a max number of transform stats to get,
+            defaults to 100
+        """
+        # from is a reserved word so it cannot be used, use from_ instead
+        if "from_" in params:
+            params["from"] = params.pop("from_")
+
+        if transform_id in SKIP_IN_PATH:
+            raise ValueError(
+                "Empty value passed for a required argument 'transform_id'."
+            )
+
+        return self.transport.perform_request(
+            "GET", _make_path("_transform", transform_id, "_stats"), params=params
+        )
+
+    @query_params()
+    def preview_transform(self, body, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html>`_
+
+        :arg body: The definition for the transform to preview
+        """
+        if body in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for a required argument 'body'.")
+
+        return self.transport.perform_request(
+            "POST", "/_transform/_preview", params=params, body=body
+        )
+
+    @query_params("defer_validation")
+    def put_transform(self, transform_id, body, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html>`_
+
+        :arg transform_id: The id of the new transform.
+        :arg body: The transform definition
+        :arg defer_validation: If validations should be deferred until
+            transform starts, defaults to false.
+        """
+        for param in (transform_id, body):
+            if param in SKIP_IN_PATH:
+                raise ValueError("Empty value passed for a required argument.")
+
+        return self.transport.perform_request(
+            "PUT", _make_path("_transform", transform_id), params=params, body=body
+        )
+
+    @query_params("timeout")
+    def start_transform(self, transform_id, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html>`_
+
+        :arg transform_id: The id of the transform to start
+        :arg timeout: Controls the time to wait for the transform to
+            start
+        """
+        if transform_id in SKIP_IN_PATH:
+            raise ValueError(
+                "Empty value passed for a required argument 'transform_id'."
+            )
+
+        return self.transport.perform_request(
+            "POST", _make_path("_transform", transform_id, "_start"), params=params
+        )
+
+    @query_params("allow_no_match", "timeout", "wait_for_completion")
+    def stop_transform(self, transform_id, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html>`_
+
+        :arg transform_id: The id of the transform to stop
+        :arg allow_no_match: Whether to ignore if a wildcard expression
+            matches no transforms. (This includes `_all` string or when no
+            transforms have been specified)
+        :arg timeout: Controls the time to wait until the transform has
+            stopped. Default to 30 seconds
+        :arg wait_for_completion: Whether to wait for the transform to
+            fully stop before returning or not. Default to false
+        """
+        if transform_id in SKIP_IN_PATH:
+            raise ValueError(
+                "Empty value passed for a required argument 'transform_id'."
+            )
+
+        return self.transport.perform_request(
+            "POST", _make_path("_transform", transform_id, "_stop"), params=params
+        )
+
+    @query_params("defer_validation")
+    def update_transform(self, transform_id, body, params=None):
+        """
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html>`_
+
+        :arg transform_id: The id of the transform.
+        :arg body: The update transform definition
+        :arg defer_validation: If validations should be deferred until
+            transform starts, defaults to false.
+        """
+        for param in (transform_id, body):
+            if param in SKIP_IN_PATH:
+                raise ValueError("Empty value passed for a required argument.")
+
+        return self.transport.perform_request(
+            "POST",
+            _make_path("_transform", transform_id, "_update"),
+            params=params,
+            body=body,
+        )