cayu.snapshots.AgentSnapshotOverlayRef

Part of cayu.snapshots.base. Read the Python API overview and install the required extra.

from cayu.snapshots import AgentSnapshotOverlayRef

Bases: _SnapshotModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
kind	AgentSnapshotOverlayKind	required
overlay_id	StrictStr	Field(max_length=256)
fingerprint	StrictStr	required
baseline_fingerprint	StrictStr	required
candidate_id	StrictStr	Field(max_length=256)
state_scope_id	StrictStr	Field(max_length=256)
source_ref	StrictStr | None	Field(default=None, max_length=512)

validate_identity (method)

AgentSnapshotOverlayRef.validate_identity(value: str, info) -> str

validate_fingerprint (method)

AgentSnapshotOverlayRef.validate_fingerprint(value: str, info) -> str

validate_source_ref (method)

AgentSnapshotOverlayRef.validate_source_ref(value: str | None) -> str | None

validate_fingerprint_matches (method)

AgentSnapshotOverlayRef.validate_fingerprint_matches() -> AgentSnapshotOverlayRef

identity_material (method)

AgentSnapshotOverlayRef.identity_material() -> dict[str, object]

create (method)

AgentSnapshotOverlayRef.create(*, kind: AgentSnapshotOverlayKind, overlay_id: str, baseline_fingerprint: str, candidate_id: str, state_scope_id: str, source_ref: str | None=None) -> AgentSnapshotOverlayRef

Release source · Runtime guarantees · Capability guides