domino_admin_toolkit.status.status module

pydantic model domino_admin_toolkit.status.status.CheckResult

Bases: BaseModel

Represents the result of a check.

Attributes:

status (Status): The status of the check. msg (str): A message providing additional information about the check result. details (Union[str, dict, None]): Additional details about the check result. analyzer_name (str): The name of the analyzer that produced this result.

Fields:

• analyzer_name (str | None)

• details (str | dict | None)

• msg (str)

• status (domino_admin_toolkit.status.status.Status)

field analyzer_name: str | None = None

field details: str | dict | None = None

field msg: str [Required]

field status: Status [Required]

class domino_admin_toolkit.status.status.Status(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enumeration for representing the status of a check.

Members:

PASS: Indicates that the check passed successfully. FAIL: Indicates that the check failed. WARN: Indicates that the check passed with warnings. ERROR: Indicates that there was an error during the check.

ERROR = 'error'

FAIL = 'fail'

PASS = 'pass'

WARN = 'warn'