class cobra.model.event.Record

class cobra.model.event.Record

Represents an immutable object that records a state transition for an event instance object. Record creation is triggered by event:Inst object creation or deletion, or by modification of key properties (for example, severity, lifecycle, or acknowledgement). Because an object of this class is immutable, all properties are set at the time the object is created. A record contains a complete snapshot of the event instance object and is logically organized as a flat list under a single container. The record is meant to be queried using time-based filters and possibly prop-filters for severity, affected DN, or other criteria. Inherited properties, as well as severity (original,highest,previous), acknowledgement, occurrance, and lifecycle provide a snapshot of the event instance. The record object contains properties from the corresponding instance object (event:Inst) as well as other properties that provide a snapshot of the event instance and the nature and time of its change. The transition time, affected object, trigger, action indicator, and record ID, in addition to properties from the instance object, characterize the event record. NOTE: The properties of the event record object must be kept in sync with the properties of the event instance object.

Containers:
Properties:

  • affected : A reference to the affected object. For example, when a user modifies an object, this property is set to the DN of that object.

    • isNaming: False
    • isCreateOnly: True
    • isConfig: True
    • isImplicit: False

  • cause : A property that indicates cause that led to the creation of this object.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • changeSet : Summarizes the properties that were modified when this object was created.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • childAction : Delete or ignore. For internal use only.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • code : A code that helps categorize and identify different types of records objects . Record objects include fault records, event records, audit records and health records.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: True
    • isImplicit: False

  • created : A timestamp indicating when this object was created.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • descr : Additional descriptive information about the object.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • dn : A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

    • isNaming: False
    • isCreateOnly: True
    • isConfig: False
    • isImplicit: True

  • id : A unique record identifier that is assigned to the record object when the record is created.

    • isNaming: True
    • isCreateOnly: True
    • isConfig: True
    • isImplicit: False

  • ind : A property used to indicate whether the object was created, modified, or deleted.

    • isNaming: False
    • isCreateOnly: True
    • isConfig: True
    • isImplicit: False

  • modTs : The time when this object was last modified.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • rn : Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

    • isNaming: False
    • isCreateOnly: True
    • isConfig: False
    • isImplicit: True

  • severity : A property that indicates severity level of the reportable object.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • status : The upgrade status. This property is for internal use only.

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • trig : null

    • isNaming: False
    • isCreateOnly: False
    • isConfig: False
    • isImplicit: True

  • txId : A property that indicates identifier of the transaction in which the user action occurred.

    • isNaming: False
    • isCreateOnly: True
    • isConfig: True
    • isImplicit: False

  • user : A property that indicates name of the user who performed the action.

    • isNaming: False
    • isCreateOnly: True
    • isConfig: True
    • isImplicit: False