mstrio.distribution_services package

Subpackages

Submodules

mstrio.distribution_services.event module

class mstrio.distribution_services.event.Event(connection: mstrio.connection.Connection, id: Optional[str] = None, name: Optional[str] = None)

Bases: mstrio.utils.entity.Entity, mstrio.utils.entity.DeleteMixin

Class representation of MicroStrategy Event object.

connection

A MicroStrategy connection object

name

Event name

id

Event ID

description

Event descriptions

alter(name: Optional[str] = None, description: Optional[str] = None)

Alter the Event’s properties

Parameters
  • name – New name for the Event

  • description – New description for the Event

classmethod create(connection: mstrio.connection.Connection, name: str, description: Optional[str] = None) mstrio.distribution_services.event.Event

Create an Event

Parameters
  • connection – MicroStrategy connection object returned by connection.Connection().

  • name – Name of the new Event

  • description – Description of the new Event

trigger()

Trigger the Event

mstrio.distribution_services.event.list_events(connection: mstrio.connection.Connection, to_dictionary: bool = False, limit: Optional[int] = None, **filters) Union[List[mstrio.distribution_services.event.Event], List[dict]]

List event objects or event dictionaries. Optionally filter list.

Parameters
  • connection (object) – MicroStrategy connection object returned by ‘connection.Connection()’

  • to_dictionary (bool, optional) – if True, return event as list of dicts

  • limit (int, optional) – maximum number of Events returned.

  • **filters – Available filter parameters:[‘name’:, ‘id’, ‘description’]

Module contents