cayu.collaboration.participants

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.

CollaborationBootstrap

from cayu.collaboration import CollaborationBootstrap

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
application_scope	Identifier	required
provisioning_scope	Identifier	required
owner_name	Identifier	required
limits	CollaborationLimits	required
version	VersionOne	1

bounded_input (method)

CollaborationBootstrap.bounded_input(value: object) -> Any

immutable_fields (method)

CollaborationBootstrap.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

CollaborationCapacityExceeded

from cayu.collaboration import CollaborationCapacityExceeded

New admission would exceed retained-state capacity.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

CollaborationInitialization

from cayu.collaboration import CollaborationInitialization

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
binding	CollaborationBootstrap	required
owner	OwnerRef	required
namespace_incarnation	Identifier	required
generation	VersionOne	1

bounded_input (method)

CollaborationInitialization.bounded_input(value: object) -> Any

immutable_fields (method)

CollaborationInitialization.immutable_fields() -> ContractValue

bound_owner (method)

CollaborationInitialization.bound_owner() -> CollaborationInitialization

operation (method)

CollaborationInitialization.operation(caller_key: str) -> OperationRef

Release source · Runtime guarantees · Capability guides

CollaborationLimits

from cayu.collaboration import CollaborationLimits

Finite, immutable bootstrap limits; reserved controls cannot be borrowed.

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
participants	Generation	required
aliases	Generation	required
operations	Generation	required
events	Generation	required
retained_bytes	Generation	required
control_operations	Generation	required
control_events	Generation	required
control_bytes	Generation	required
namespaces	Generation	required
generations	Generation	required
obligations	Generation	required

bounded_input (method)

CollaborationLimits.bounded_input(value: object) -> Any

immutable_fields (method)

CollaborationLimits.immutable_fields() -> ContractValue

control_reserves_fit (method)

CollaborationLimits.control_reserves_fit() -> CollaborationLimits

Release source · Runtime guarantees · Capability guides

CollaborationNotInitialized

from cayu.collaboration import CollaborationNotInitialized

Explicit collaboration initialization has not completed.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

CollaborationUnavailable

from cayu.collaboration import CollaborationUnavailable

Authoritative collaboration evidence or configuration is unavailable.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

ParticipantAlias

from cayu.collaboration import ParticipantAlias

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
alias	Identifier	required
target	ParticipantRef	required
revision	Generation	required

bounded_input (method)

ParticipantAlias.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantAlias.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantAliasChange

from cayu.collaboration import ParticipantAliasChange

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
operation	OperationRef	required
alias	Identifier	required
expected_alias_revision	Counter	required
expected_target	ParticipantRef | None	required
target	ParticipantRef | None	required
kind	Literal['alias']	'alias'

bounded_input (method)

ParticipantAliasChange.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantAliasChange.immutable_fields() -> ContractValue

changes_binding (method)

ParticipantAliasChange.changes_binding() -> ParticipantAliasChange

Release source · Runtime guarantees · Capability guides

ParticipantCommand

from cayu.collaboration import ParticipantCommand

Identity-family controls are closed schema, not caller-authored text.

Bases: ExpectedOperation[ParticipantIntent].

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
operation	OperationRef	required
kind	Literal['create', 'configure', 'alias']	required
schema_version	VersionOne	1
mode	Literal['identity']	'identity'
source	OwnerRef	required
destination	OwnerRef	required
initiator	InitiatorBinding	required
receipt_stage	Literal['committed']	'committed'
intent	IntentT	required

bounded_input (method)

ParticipantCommand.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantCommand.immutable_fields() -> ContractValue

operation_scope (method)

ParticipantCommand.operation_scope() -> ExpectedOperation[IntentT]

Release source · Runtime guarantees · Capability guides

ParticipantConfiguration

from cayu.collaboration import ParticipantConfiguration

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
definition	ParticipantConfigurationRef	required
routing	ParticipantConfigurationRef	required
admission	ParticipantConfigurationRef	required

bounded_input (method)

ParticipantConfiguration.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantConfiguration.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantConfigurationRef

from cayu.collaboration import ParticipantConfigurationRef

Application-registered version, not executable serialized configuration.

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
name	Identifier	required
version	Generation	required

bounded_input (method)

ParticipantConfigurationRef.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantConfigurationRef.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantConfigure

from cayu.collaboration import ParticipantConfigure

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
operation	OperationRef	required
participant	ParticipantRef	required
expected_configuration_revision	Generation	required
configuration	ParticipantConfiguration	required
kind	Literal['configure']	'configure'

bounded_input (method)

ParticipantConfigure.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantConfigure.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantCreate

from cayu.collaboration import ParticipantCreate

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
operation	OperationRef	required
configuration	ParticipantConfiguration	required
alias	Identifier | None	None
expected_alias_revision	Counter	0
kind	Literal['create']	'create'

bounded_input (method)

ParticipantCreate.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantCreate.immutable_fields() -> ContractValue

absent_alias (method)

ParticipantCreate.absent_alias() -> ParticipantCreate

Release source · Runtime guarantees · Capability guides

ParticipantCursor

from cayu.collaboration import ParticipantCursor

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
allowed	tuple[ParticipantRef, ...] | None	required
after_id	Identifier	required

bounded_input (method)

ParticipantCursor.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantEvent

from cayu.collaboration import ParticipantEvent

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
id	Identifier	required
sequence	Generation	required
operation	OperationRef | None	required
type	Literal['initialized', 'created', 'configured', 'alias_changed', 'namespace_sealed', 'namespace_rotated', 'namespace_retired', 'namespace_pruned', 'participant_lifecycle_changed', 'permit_registered', 'permit_settled', 'permit_excluded']	required
participants	tuple[ParticipantRef, ...]	Field(max_length=2)

bounded_input (method)

ParticipantEvent.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantEvent.immutable_fields() -> ContractValue

event_shape (method)

ParticipantEvent.event_shape() -> ParticipantEvent

Release source · Runtime guarantees · Capability guides

ParticipantEventCursor

from cayu.collaboration import ParticipantEventCursor

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
allowed	tuple[ParticipantRef, ...] | None	required
after_sequence	Counter	required
retention_revision	Generation	required

bounded_input (method)

ParticipantEventCursor.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantEventCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantEventPage

from cayu.collaboration import ParticipantEventPage

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
events	tuple[ParticipantEvent, ...]	Field(max_length=64)
next_cursor	ParticipantEventCursor | None	required
retention_revision	Generation	required
history_complete	StrictBool	required

bounded_input (method)

ParticipantEventPage.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantEventPage.immutable_fields() -> ContractValue

retained_history (method)

ParticipantEventPage.retained_history() -> ParticipantEventPage

Release source · Runtime guarantees · Capability guides

ParticipantInspection

from cayu.collaboration import ParticipantInspection

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	ParticipantSnapshot	required
alias_revision	Counter	required
issued_permit_frontier	Counter	required
outstanding_obligations	Counter	required
settlement	Literal['settled', 'unsettled']	required

bounded_input (method)

ParticipantInspection.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantInspection.immutable_fields() -> ContractValue

positive_settlement (method)

ParticipantInspection.positive_settlement() -> ParticipantInspection

Release source · Runtime guarantees · Capability guides

ParticipantIntent

from cayu.collaboration import ParticipantIntent

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
request	ParticipantMutation	required
limits	CollaborationLimits	required

bounded_input (method)

ParticipantIntent.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantIntent.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantPage

from cayu.collaboration import ParticipantPage

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
participants	tuple[ParticipantSnapshot, ...]	Field(max_length=64)
next_cursor	ParticipantCursor | None	required

bounded_input (method)

ParticipantPage.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantReceipt

from cayu.collaboration import ParticipantReceipt

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
expected	ParticipantCommand	required
participants	tuple[ParticipantSnapshot, ...]	Field(max_length=2)
alias	ParticipantAlias | None	required
alias_revision	Counter	required
event	ParticipantEvent	required

bounded_input (method)

ParticipantReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantReceipt.immutable_fields() -> ContractValue

exact_result (method)

ParticipantReceipt.exact_result() -> ParticipantReceipt

Release source · Runtime guarantees · Capability guides

ParticipantRef

from cayu.collaboration import ParticipantRef

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
owner	OwnerRef	required
participant_id	Identifier	required
incarnation	Identifier	required

bounded_input (method)

ParticipantRef.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantRef.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

ParticipantSnapshot

from cayu.collaboration import ParticipantSnapshot

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
reference	ParticipantRef	required
configuration	ParticipantConfiguration	required
configuration_revision	Generation	required
lifecycle	Literal['active', 'draining', 'disabled', 'retired']	'active'
lifecycle_revision	Generation	1
admission_generation	Generation	1
covered_permit_frontier	Counter	0
control_policy	Literal['settle_registered']	'settle_registered'

bounded_input (method)

ParticipantSnapshot.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantSnapshot.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides