ironic.objects.notification module

ironic.objects.notification module

service None

Bases: ironic.objects.base.IronicObject

Defines the event_type to be sent on the wire.

An EventType must specify the object being acted on, a string describing the action being taken on the notification, and the status of the action.

EventType.to_event_type_field()

Constructs string for event_type to be sent on the wire.

The string is in the format: baremetal.<object>.<action>.<status>

Raises:ValueError if self.status is not one of fields.NotificationStatusField
Returns:event_type string
service None

Bases: ironic.objects.base.IronicObject

Base class for versioned notifications.

Subclasses must define the “payload” field, which must be a subclass of NotificationPayloadBase.

NotificationBase.emit(context)

Send the notification.

Raises:NotificationPayloadError
Raises:oslo_versionedobjects.exceptions.MessageDeliveryFailure
service None

Bases: ironic.objects.base.IronicObject

Base class for the payload of versioned notifications.

NotificationPayloadBase.populate_schema(**kwargs)

Populate the object based on the SCHEMA and the source objects

Parameters:kwargs – A dict contains the source object and the keys defined in the SCHEMA
Raises:NotificationSchemaObjectError
Raises:NotificationSchemaKeyError
service None

Bases: ironic.objects.base.IronicObject

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.