SPL-142009: Splunk SDK for python was expecting wrong value of type='eventing', whereas it should have been 'type=events', which is in consistency with splunk code.

Author: gaurav22gupta

splunklib/searchcommands/generating_command.py

@@ -56,7 +56,7 @@ class GeneratingCommand(SearchCommand):
     +==========+=====================================+============================================+
     | streams  | streaming=True[,local=[True|False]] | type='streaming'[,distributed=[true|false] |
     +----------+-------------------------------------+--------------------------------------------+
-    | events   | retainsevents=True, streaming=False | type='eventing'                            |
+    | events   | retainsevents=True, streaming=False | type='events'                              |
     +----------+-------------------------------------+--------------------------------------------+
     | reports  | streaming=False                     | type='reporting'                           |
     +----------+-------------------------------------+--------------------------------------------+
@@ -112,7 +112,7 @@ class StreamingGeneratingCommand(GeneratingCommand)
     |          | settings to your command class:                   | setting to your command class:                    |
     |          |                                                   |                                                   |
     |          | .. code-block:: python                            | .. code-block:: python                            |
-    |          |     @Configuration(                               |     @Configuration(type='eventing')               |
+    |          |     @Configuration(                               |     @Configuration(type='events')                 |
     |          |         retainsevents=True, streaming=False)      |     class SomeCommand(GeneratingCommand)          |
     |          |     class SomeCommand(GeneratingCommand)          |         ...                                       |
     |          |         ...                                       |                                                   |
@@ -127,7 +127,7 @@ class StreamingGeneratingCommand(GeneratingCommand)
     Configure your command class like this, if you wish to support both protocols:
 
     .. code-block:: python
-        @Configuration(type='eventing', retainsevents=True, streaming=False)
+        @Configuration(type='events', retainsevents=True, streaming=False)
         class SomeCommand(GeneratingCommand)
             ...
 
@@ -280,7 +280,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
             ====================  ======================================================================================
             Value                 Description
             --------------------  --------------------------------------------------------------------------------------
-            :const:`'eventing'`   Runs as the first command in the Splunk events pipeline. Cannot be distributed.
+            :const:`'events'`     Runs as the first command in the Splunk events pipeline. Cannot be distributed.
             :const:`'reporting'`  Runs as the first command in the Splunk reports pipeline. Cannot be distributed.
             :const:`'streaming'`  Runs as the first command in the Splunk streams pipeline. May be distributed.
             ====================  ======================================================================================

splunklib/searchcommands/internals.py

@@ -326,7 +326,7 @@ def validate_configuration_setting(specification, name, value):
             supporting_protocols=[1, 2]),
         'type': specification(
             type=(bytes, unicode),
-            constraint=lambda value: value in ('eventing', 'reporting', 'streaming'),
+            constraint=lambda value: value in ('events', 'reporting', 'streaming'),
             supporting_protocols=[2])}