PLC/Methods/GetEvents.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Filter import Filter
   5 from PLC.Events import Event, Events
   6 from PLC.Auth import Auth
   7
   8 class GetEvents(Method):
   9     """
  10     Returns an array of structs containing details about events and
  11     faults. If event_filter is specified and is an array of event
  12     identifiers, or a struct of event attributes, only events matching
  13     the filter will be returned. If return_fields is specified, only the
  14     specified details will be returned.
  15     """
  16
  17     roles = ['admin']
  18
  19     accepts = [
  20         Auth(),
  21         Mixed([Event.fields['event_id']],
  22               Filter(Event.fields)),
  23         Parameter([str], "List of fields to return", nullok = True)
  24         ]
  25
  26     returns = [Event.fields]
  27
  28     def call(self, auth, event_filter = None, return_fields = None):
  29         return Events(self.api, event_filter, return_fields)