RunEvent (autotransform.event.run)

The RunEvent is triggered whenever an AutoTransform script is run and provides information on the run.

class autotransform.event.run.RunCommandFailedEvent(data: TData)

Bases: Event[RunCommandFailedEventData]

An Event triggered when a command run fails.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunCommandFailedEventData

Bases: TypedDict

The data for a RunCommandFailedEvent. Contains the information that will be logged when the event is triggered.

error: Exception

class autotransform.event.run.RunEvent(data: TData)

Bases: Event[RunEventData]

An Event triggered when a schema is run using the run mode.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunEventData

Bases: TypedDict

The data for a RunEvent. Contains the information that will be logged when the event is triggered.

schema: AutoTransformSchema

class autotransform.event.run.RunFailedEvent(data: TData)

Bases: Event[RunFailedEventData]

An Event triggered when a schema run fails.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunFailedEventData

Bases: TypedDict

The data for a RunFailedEvent. Contains the information that will be logged when the event is triggered.

error: Exception

schema: AutoTransformSchema

class autotransform.event.run.RunManagerEvent(data: TData)

Bases: Event[RunManagerEventData]

An event triggered whenever the Manager is invoked.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunManagerEventData

Bases: TypedDict

The data for a RunManagerEvent. Contains the information that will be logged when the event is triggered.

manager: Manager

class autotransform.event.run.RunManagerFailedEvent(data: TData)

Bases: Event[RunManagerFailedEventData]

An event triggered when the Manager fails.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunManagerFailedEventData

Bases: TypedDict

The data for a RunManagerFailedEvent. Contains the information that will be logged when the event is triggered.

error: Exception

manager: Manager

class autotransform.event.run.RunSchedulerEvent(data: TData)

Bases: Event[RunSchedulerEventData]

An event triggered whenever the Scheduler is invoked.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunSchedulerEventData

Bases: TypedDict

The data for a RunSchedulerEvent. Contains the information that will be logged when the event is triggered.

scheduler: Scheduler

class autotransform.event.run.RunSchedulerFailedEvent(data: TData)

Bases: Event[RunSchedulerFailedEventData]

An event triggered when the Scheduler fails.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunSchedulerFailedEventData

Bases: TypedDict

The data for a RunSchedulerFailedEvent. Contains the information that will be logged when the event is triggered.

error: Exception

scheduler: Scheduler

class autotransform.event.run.RunUpdateEvent(data: TData)

Bases: Event[RunUpdateEventData]

An event triggered whenever an update is invoked.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunUpdateEventData

Bases: TypedDict

The data for a RunUpdateEvent. Contains the information that will be logged when the event is triggered.

change: Change

class autotransform.event.run.RunUpdateFailedEvent(data: TData)

Bases: Event[RunUpdateFailedEventData]

An event triggered when an update fails.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:: The logging detail required to log this event.
Return type:: LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:: The unique type associated with this Event.
Return type:: EventType

class autotransform.event.run.RunUpdateFailedEventData

Bases: TypedDict

The data for a RunUpdateFailedEvent. Contains the information that will be logged when the event is triggered.

change: Change

error: Exception