Class LiveActionDB

st2common/st2common/models/db/liveaction.py:40–126

class LiveActionDB(stormbase.StormFoundationDB):
    workflow_execution = me.StringField()
    task_execution = me.StringField()
    # TODO: Can status be an enum at the Mongo layer?
    status = me.StringField(
        required=True, help_text="The current status of the liveaction."
    )
    start_timestamp = ComplexDateTimeField(
        default=date_utils.get_datetime_utc_now,
        help_text="The timestamp when the liveaction was created.",
    )
    end_timestamp = ComplexDateTimeField(
        help_text="The timestamp when the liveaction has finished."
    )
    action = me.StringField(
        required=True, help_text="Reference to the action that has to be executed."
    )
    action_is_workflow = me.BooleanField(
        default=False,
        help_text="A flag indicating whether the referenced action is a workflow.",
    )
    parameters = stormbase.EscapedDynamicField(
        default={},
        help_text="The key-value pairs passed as to the action runner & execution.",
    )
    result = JSONDictEscapedFieldCompatibilityField(
        default={}, help_text="Action defined result."
    )
    context = me.DictField(
        default={}, help_text="Contextual information on the action execution."
    )
    callback = me.DictField(
        default={},
        help_text="Callback information for the on completion of action execution.",
    )
    runner_info = me.DictField(
        default={},
        help_text="Information about the runner which executed this live action (hostname, pid).",
    )
    notify = me.EmbeddedDocumentField(NotificationSchema)
    delay = me.IntField(
        min_value=0,
        help_text="How long (in milliseconds) to delay the execution before scheduling.",
    )

    meta = {
        "indexes": [
            {"fields": ["-start_timestamp", "action"]},
            {"fields": ["start_timestamp"]},
            {"fields": ["end_timestamp"]},
            {"fields": ["action"]},
            {"fields": ["status"]},
            {"fields": ["context.trigger_instance.id"]},
            {"fields": ["workflow_execution"]},
            {"fields": ["task_execution"]},
        ],
    }