cayu.collaboration.waits

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.

`CollaborationWait`

from cayu.collaboration import CollaborationWait

Immutable finite wait registration.

Version one qualifies collaboration request references as its source. The target identity remains explicit so later source families can be added without changing the election contract.

Bases: ContractValue.

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
`unordered_fields`	`class attribute`	`frozenset({'targets'})`
`operation`	`OperationRef`	`required`
`source_owner`	`OwnerRef`	`required`
`targets`	`tuple[RequestCommand, ...]`	`Field(min_length=1, max_length=MAX_WAIT_TARGETS)`
`predicate`	`WaitPredicate`	`required`
`predicate_version`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`threshold`	`StrictInt \| None`	`Field(default=None, ge=1, le=MAX_WAIT_TARGETS)`
`deadline`	`StrictStr`	`required`
`failure_policy`	`StrictStr`	`Field(min_length=1, max_length=128)`
`service_policy`	`StrictStr`	`Field(min_length=1, max_length=128)`
`projection`	`ObjectRef \| None`	`None`
`wait_edge_revision`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`initiator`	`InitiatorBinding`	`required`
`delivery_ticket`	`ContinuationTicket \| None`	`None`

bounded_input (method)

CollaborationWait.bounded_input(value: object) -> Any

immutable_fields (method)

CollaborationWait.immutable_fields() -> ContractValue

normalize_exact_duplicate_targets (method)

CollaborationWait.normalize_exact_duplicate_targets(value: object) -> object

Remove identical unordered targets before base uniqueness checks.

from_values (method)

CollaborationWait.from_values(**values: object) -> CollaborationWait

target_keys (property)

CollaborationWait.target_keys() -> tuple[str, ...]

source_keys (property)

CollaborationWait.source_keys() -> tuple[str, ...]

validate_wait (method)

CollaborationWait.validate_wait() -> CollaborationWait

Release source · Runtime guarantees · Capability guides

`ParticipantSessionWaitExclusionReceipt`

from cayu.collaboration import ParticipantSessionWaitExclusionReceipt

Content-free native cleanup result; not a wait snapshot or execution grant.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`operation`	`OperationRef`	`required`
`session_id`	`Identifier`	`required`
`session_instance_id`	`Identifier`	`required`
`registration_key`	`Identifier`	`required`
`execution_admission_sha256`	`StrictStr`	`Field(pattern='^[0-9a-f]{64}$')`
`retirement_sha256`	`StrictStr`	`Field(pattern='^[0-9a-f]{64}$')`
`delivery`	`Literal['excluded']`	`'excluded'`

bounded_input (method)

ParticipantSessionWaitExclusionReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantSessionWaitExclusionReceipt.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

`WaitControl`

from cayu.collaboration import WaitControl

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`operation`	`OperationRef`	`required`
`expected_revision`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`action`	`Literal['cancel', 'expire']`	`required`
`initiator`	`OwnerRef`	`required`

bounded_input (method)

WaitControl.bounded_input(value: object) -> Any

immutable_fields (method)

WaitControl.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

`WaitElection`

from cayu.collaboration import WaitElection

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`unordered_fields`	`class attribute`	`frozenset({'selected', 'evidence'})`
`result`	`Literal['success', 'settled', 'failure', 'unavailable']`	`required`
`selected`	`tuple[RequestRef, ...]`	`Field(max_length=MAX_WAIT_TARGETS)`
`evidence`	`tuple[WaitEvidence, ...]`	`Field(max_length=MAX_WAIT_EVIDENCE)`
`sequence`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`elected_at_ms`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`outcome_digest`	`Identifier`	`required`

bounded_input (method)

WaitElection.bounded_input(value: object) -> Any

immutable_fields (method)

WaitElection.immutable_fields() -> ContractValue

exact_election (method)

WaitElection.exact_election() -> WaitElection

Release source · Runtime guarantees · Capability guides

`WaitEvidence`

from cayu.collaboration import WaitEvidence

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`target`	`RequestRef`	`required`
`status`	`WaitEvidenceStatus`	`required`
`ingestion_sequence`	`StrictInt`	`Field(default=0, ge=0, le=MAX_PORTABLE_JSON_INTEGER)`
`source_sequence`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`accepted_at_ms`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`observed_at_ms`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`receipt_digest`	`Identifier`	`required`
`commitment`	`Identifier \| None`	`None`

bounded_input (method)

WaitEvidence.bounded_input(value: object) -> Any

immutable_fields (method)

WaitEvidence.immutable_fields() -> ContractValue

bounded_evidence (method)

WaitEvidence.bounded_evidence() -> WaitEvidence

Release source · Runtime guarantees · Capability guides

`WaitRegistration`

from cayu.collaboration import WaitRegistration

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`mode`	`Literal['collaboration_wait']`	`'collaboration_wait'`
`wait`	`CollaborationWait`	`required`
`registration_digest`	`Identifier`	`required`
`registered_sequence`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`

bounded_input (method)

WaitRegistration.bounded_input(value: object) -> Any

immutable_fields (method)

WaitRegistration.immutable_fields() -> ContractValue

exact_registration (method)

WaitRegistration.exact_registration() -> WaitRegistration

Release source · Runtime guarantees · Capability guides

`WaitSnapshot`

from cayu.collaboration import WaitSnapshot

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`mode`	`Literal['collaboration_wait']`	`'collaboration_wait'`
`registration`	`WaitRegistration`	`required`
`state`	`WaitState`	`required`
`delivery`	`WaitDelivery`	`'none'`
`evidence`	`tuple[WaitEvidence, ...]`	`Field(default=(), max_length=MAX_WAIT_EVIDENCE)`
`election`	`WaitElection \| None`	`None`
`revision`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`source_pins`	`tuple[str, ...]`	`Field(default=(), max_length=MAX_WAIT_TARGETS)`
`delivery_receipt_digest`	`Identifier \| None`	`None`
`terminal_at_ms`	`StrictInt \| None`	`Field(default=None, ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`reserved_bytes`	`StrictInt`	`Field(default=WAIT_RESERVED_BYTES, ge=0)`
`reserved_events`	`StrictInt`	`Field(default=WAIT_RESERVED_EVENTS, ge=0)`
`events`	`tuple[WaitEvent, ...]`	`Field(default=(), max_length=MAX_WAIT_EVENTS)`

bounded_input (method)

WaitSnapshot.bounded_input(value: object) -> Any

immutable_fields (method)

WaitSnapshot.immutable_fields() -> ContractValue

coherent_snapshot (method)

WaitSnapshot.coherent_snapshot() -> WaitSnapshot

Release source · Runtime guarantees · Capability guides