Skip to content

RuleResult

Source code in docs_src/capo_ssm_sap/types/rule_result.py
class RuleResult(TypedDict, closed=True):
    id: NotRequired["capo_ssm_sap.types.rule_result_id.RuleResultId"]
    """<p>The unique identifier of the rule result.</p>"""
    description: NotRequired["str"]
    """<p>A description of what the rule validates.</p>"""
    status: NotRequired["capo_ssm_sap.types.rule_result_status.RuleResultStatus"]
    """<p>The status of the rule result.</p>"""
    message: NotRequired["str"]
    """<p>A message providing details about the rule result.</p>"""
    metadata: NotRequired["capo_ssm_sap.types.rule_result_metadata.RuleResultMetadata"]
    """<p>Additional metadata associated with the rule result.</p>"""

description instance-attribute

description: NotRequired[str]

A description of what the rule validates.

id instance-attribute

id: NotRequired[RuleResultId]

The unique identifier of the rule result.

message instance-attribute

message: NotRequired[str]

A message providing details about the rule result.

metadata instance-attribute

metadata: NotRequired[RuleResultMetadata]

Additional metadata associated with the rule result.

status instance-attribute

status: NotRequired[RuleResultStatus]

The status of the rule result.