valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 17:33:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #8618 from basepi/geteventdocs

Browse Source 
Update api.get_event docs to match SaltEvent.get_event
This commit is contained in:
Colton Myers 2013-11-18 15:43:02 -08:00
commit 58f7bb6279
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
salt/client/api.py
View File

@ -280,13 +280,11 @@ class APIClient(object):
def get_event(self, wait=0.25, tag='', full=False): def get_event(self, wait=0.25, tag='', full=False):
''' '''
Returns next available event with tag tag from event bus Get a single salt event.
If any within wait seconds If no events are available, then block for up to ``wait`` seconds.
Return the event if it matches the tag (or ``tag`` is empty)
Otherwise return None Otherwise return None
If tag is empty then return events for all tags
If full then add tag field to returned data
If wait is 0 then block forever or until next event becomes available. If wait is 0 then block forever or until next event becomes available.
''' '''
return (self.event.get_event(wait=wait, tag=tag, full=full)) return (self.event.get_event(wait=wait, tag=tag, full=full))