The panko.api.controllers.v2.events Module

class panko.api.controllers.v2.events.Event(**kw)[source]

Bases: panko.api.controllers.v2.base.Base

A System event.

get_traits()[source]
classmethod sample()[source]
set_traits(traits)[source]
class panko.api.controllers.v2.events.EventQuery(**kw)[source]

Bases: panko.api.controllers.v2.base.Query

Query arguments for Event Queries.

classmethod sample()[source]
class panko.api.controllers.v2.events.EventTypesController[source]

Bases: pecan.rest.RestController

Works on Event Types in the system.

get_all(*args, **kwargs)[source]

Get all event types.

get_one(*args, **kwargs)[source]

Unused API, will always return 404.

Parameters:event_type – A event type
class panko.api.controllers.v2.events.EventsController[source]

Bases: pecan.rest.RestController

Works on Events.

get_all(*args, **kwargs)[source]

Return all events matching the query filters.

Parameters:
  • q – Filter arguments for which Events to return
  • limit – Maximum number of samples to be returned.
  • sort – A pair of sort key and sort direction combined with ”:”
  • marker – The pagination query marker, message id of the last item viewed
get_one(*args, **kwargs)[source]

Return a single event with the given message id.

Parameters:message_id – Message ID of the Event to be returned
class panko.api.controllers.v2.events.Trait(**kw)[source]

Bases: panko.api.controllers.v2.base.Base

A Trait associated with an event.

classmethod sample()[source]
class panko.api.controllers.v2.events.TraitDescription(**kw)[source]

Bases: panko.api.controllers.v2.base.Base

A description of a trait, with no associated value.

classmethod sample()[source]
class panko.api.controllers.v2.events.TraitsController[source]

Bases: pecan.rest.RestController

Works on Event Traits.

get_all(*args, **kwargs)[source]

Return all trait names for an event type.

Parameters:event_type – Event type to filter traits by
get_one(*args, **kwargs)[source]

Return all instances of a trait for an event type.

Parameters:
  • event_type – Event type to filter traits by
  • trait_name – Trait to return values for