mstrio.distribution_services package

Subpackages

• mstrio.distribution_services.device package
  • Submodules
  • mstrio.distribution_services.device.device module
  • mstrio.distribution_services.device.device_properties module
  • Module contents
• mstrio.distribution_services.schedule package
  • Submodules
  • mstrio.distribution_services.schedule.schedule module
  • mstrio.distribution_services.schedule.schedule_time module
  • Module contents
• mstrio.distribution_services.subscription package
  • Submodules
  • mstrio.distribution_services.subscription.base_subscription module
  • mstrio.distribution_services.subscription.cache_update_subscription module
  • mstrio.distribution_services.subscription.common module
  • mstrio.distribution_services.subscription.content module
  • mstrio.distribution_services.subscription.delivery module
  • mstrio.distribution_services.subscription.dynamic_recipient_list module
  • mstrio.distribution_services.subscription.email_subscription module
  • mstrio.distribution_services.subscription.file_subscription module
  • mstrio.distribution_services.subscription.ftp_subscription module
  • mstrio.distribution_services.subscription.history_list_subscription module
  • mstrio.distribution_services.subscription.subscription_manager module
  • Module contents
• mstrio.distribution_services.transmitter package
  • Submodules
  • mstrio.distribution_services.transmitter.transmitter module
  • Module contents

Submodules

mstrio.distribution_services.event module

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

Bases: 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: Connection, name: str, description: Optional[str] = None) → 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: Connection, to_dictionary: bool = False, limit: int = None, **filters) → Union[List[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