cayu.collaboration.obligations

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.

ParticipantObligation

from cayu.collaboration import ParticipantObligation

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
participant	ParticipantRef	required
position	Generation	required
operation	OperationRef	required
source_operation	OperationRef	required
settlement_operation	OperationRef	required
admission_generation	Generation	required
expected_configuration_revision	Generation | None	None
admission_commitment	str | None	None
target	ObjectRef	required
target_state	Literal['existing', 'future']	required
effect_scope	Code	required
required_settlement	Literal['exclusion', 'quiescence']	required
state	Literal['pending', 'settled']	required
outcome	Literal['excluded', 'quiescent'] | None	required

bounded_input (method)

ParticipantObligation.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantObligation.immutable_fields() -> ContractValue

exact_scope_and_settlement (method)

ParticipantObligation.exact_scope_and_settlement()

Release source · Runtime guarantees · Capability guides

ParticipantObligationCursor

from cayu.collaboration import ParticipantObligationCursor

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
scope	Identifier	required
principal	Identifier	required
participant	ParticipantRef	required
pending_only	StrictBool	required
retention_revision	Generation	required
after_position	Generation	required

bounded_input (method)

ParticipantObligationCursor.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantObligationCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantObligationPage

from cayu.collaboration import ParticipantObligationPage

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
obligations	tuple[ParticipantObligation, ...]	Field(max_length=64)
next_cursor	ParticipantObligationCursor | None	required

bounded_input (method)

ParticipantObligationPage.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantObligationPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides