Batch Related Events (autotransform.event.batch)

The Batch events are used to handle events related to running a Batch in AutoTransform.

class autotransform.event.batch.BatchExecutionFailedEvent(data: TData)

Bases: Event[BatchExecutionFailedEventData]

A simple, generic event used to log when a batch fails to execute.

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.batch.BatchExecutionFailedEventData

Bases: TypedDict

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

batch: Batch

error: Exception

class autotransform.event.batch.BatchNoChangesEvent(data: TData)

Bases: Event[BatchNoChangesEventData]

A simple, generic event used to log when a batch finishes without changes.

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.batch.BatchNoChangesEventData

Bases: TypedDict

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

batch: Batch

class autotransform.event.batch.BatchSkipEvent(data: TData)

Bases: Event[BatchSkipEventData]

A simple, generic event used to log when a batch is skipped.

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.batch.BatchSkipEventData

Bases: TypedDict

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

batch: Batch

class autotransform.event.batch.BatchSubmitEvent(data: TData)

Bases: Event[BatchSubmitEventData]

A simple, generic event used to log when a batch is submitted.

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.batch.BatchSubmitEventData

Bases: TypedDict

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

batch: Batch

class autotransform.event.batch.BatchValidationFailedEvent(data: TData)

Bases: Event[BatchValidationFailedEventData]

A simple, generic event used to log when a batch fails validation.

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.batch.BatchValidationFailedEventData

Bases: TypedDict

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

batch: Batch

result: ValidationResult