Skip to content

cayu.egress.capabilities

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

EGRESS_CAPABILITY_EVIDENCE_SCHEMA

Section titled “EGRESS_CAPABILITY_EVIDENCE_SCHEMA”
from cayu.egress import EGRESS_CAPABILITY_EVIDENCE_SCHEMA
EGRESS_CAPABILITY_EVIDENCE_SCHEMA = 'cayu.egress_capabilities.v1'

Release source · Runtime guarantees · Capability guides

EgressCapabilityClaim

Section titled “EgressCapabilityClaim”
from cayu.egress import EgressCapabilityClaim

One bounded, secret-safe runtime capability observation.

Bases: CapabilityClaimBase.

Fields and attributes

Section titled “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
capability CapabilityIdentity required
adapter_details tuple[CapabilityDetail, ...] Field(default_factory=tuple, max_length=MAX_CAPABILITY_DETAILS)
state EgressCapabilityClaimState required
proof_source EgressCapabilityProofSource required
observation EgressCapabilityObservation | None None
reason_code EgressCapabilityReasonCode | None None
remediation_code EgressCapabilityRemediationCode | None None

validate_detail_names (method)

Section titled “validate_detail_names (method)”
EgressCapabilityClaim.validate_detail_names() -> Self

validate_state_fields (method)

Section titled “validate_state_fields (method)”
EgressCapabilityClaim.validate_state_fields() -> Self

Release source · Runtime guarantees · Capability guides

EgressCapabilityDetail

Section titled “EgressCapabilityDetail”
from cayu.egress import EgressCapabilityDetail
EgressCapabilityDetail = CapabilityDetail

Release source · Runtime guarantees · Capability guides

EgressCapabilityEvidence

Section titled “EgressCapabilityEvidence”
from cayu.egress import EgressCapabilityEvidence

Versioned runtime proof published by one virtual-egress adapter.

Bases: BaseModel.

Fields and attributes

Section titled “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
schema_version Literal['cayu.egress_capabilities.v1'] Field(default=EGRESS_CAPABILITY_EVIDENCE_SCHEMA, alias='schema')
adapter EvidenceIdentity required
claims tuple[EgressCapabilityClaim, ...] Field(default_factory=tuple, max_length=MAX_EGRESS_CAPABILITY_CLAIMS)
unclaimed_reason_code EgressUnclaimedReasonCode | None None

validate_claims (method)

Section titled “validate_claims (method)”
EgressCapabilityEvidence.validate_claims() -> Self

unclaimed (method)

Section titled “unclaimed (method)”
EgressCapabilityEvidence.unclaimed(adapter: str, *, reason_code: EgressUnclaimedReasonCode='adapter_capabilities_unclaimed') -> EgressCapabilityEvidence

claim_for (method)

Section titled “claim_for (method)”
EgressCapabilityEvidence.claim_for(capability: str) -> EgressCapabilityClaim | None

state_for (method)

Section titled “state_for (method)”
EgressCapabilityEvidence.state_for(capability: str) -> EgressCapabilityState

to_metadata (method)

Section titled “to_metadata (method)”
EgressCapabilityEvidence.to_metadata() -> dict[str, object]

Release source · Runtime guarantees · Capability guides

EgressCapabilityState

Section titled “EgressCapabilityState”
from cayu.egress import EgressCapabilityState
EgressCapabilityState = Literal['verified', 'unverified', 'unsupported', 'unclaimed']

Release source · Runtime guarantees · Capability guides