SDK-339 : Added comments on how to use List command. (#269)

qubole · Mar 26, 2019 · 0458842 · 0458842
1 parent 9365023
commit 0458842
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/qds_sdk/commands.py b/qds_sdk/commands.py
@@ -76,6 +76,20 @@ def is_success(status):
     def list(cls, **kwargs):
         """
         List a command by issuing a GET request to the /command endpoint
+
+        Args:
+            `**kwargs`: Various parameters can be used to filter the commands such as:
+                        * command_type - HiveQuery, PrestoQuery, etc. The types should be in title case.
+                        * status - failed, success, etc
+                        * name
+                        * command_id
+                        * qbol_user_id
+                        * command_source
+                        * page
+                        * cluster_label
+                        * session_id, etc
+
+            For example - Command.list(command_type = "HiveQuery", status = "success")
         """
         conn = Qubole.agent()
         params = {}