Event

from mstrio.distribution_services import Event, list_events
from mstrio.connection import get_connection

PROJECT_NAME = '<Project_name>'  # Project to connect to
EVENT_ID = '<Event_id>'  # id for Event object
EVENT_NAME = '<Name_of_event>'  # name for Event object
EVENT_DESCRIPTION = '<Description_of_event>'

conn = get_connection(workstationData, project_name=PROJECT_NAME)

# List all events
all_events = list_events(conn)

# Get event by ID. Event can be also found by its name
sample_event = Event(conn, id=EVENT_ID)
sample_event = Event(conn, name=EVENT_NAME)

# list the Event's properties
sample_event.list_properties()

# Create event with description
db_load_event = Event.create(conn, name=EVENT_NAME, description=EVENT_DESCRIPTION)

# Trigger the event
db_load_event.trigger()

# Rename the event via alter
db_load_event.alter(name=EVENT_NAME, description=EVENT_DESCRIPTION)

# Delete the event
# Please note that when argument `force` is set to `False` (default value),
# deletion must be confirmed by selecting the appropriate prompt value.
# Do also note that the Event object stored in the `db_load_event` variable is
# still valid after the rename above, as it internally references the event
# by ID, not name.
db_load_event.delete(force=True)