cayu.sessions.external_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.

`ExternalCorrelation`

from cayu import ExternalCorrelation

Bases: _Value.

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`	`ExternalCorrelationRequest`	`required`
`incarnation`	`Identifier`	`required`
`created_at_ms`	`StrictInt`	`Field(ge=0)`
`early_event_expires_at_ms`	`StrictInt`	`Field(ge=0)`
`limits`	`ExternalWaitLimits`	`required`

clean_strings (method)

ExternalCorrelation.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalCorrelationRequest`

from cayu import ExternalCorrelationRequest

Bases: _Value.

Fields and attributes

Name	Type	Default
`scope`	`ExternalWaitScope`	`required`
`correlation_key`	`Identifier`	`required`
`source`	`Identifier`	`required`
`deadline`	`datetime \| None`	`None`
`early_event_retention_seconds`	`StrictInt`	`Field(default=EXTERNAL_WAIT_RETENTION_SECONDS, ge=1, le=EXTERNAL_WAIT_MAX_RETENTION_SECONDS)`

clean_strings (method)

ExternalCorrelationRequest.clean_strings(value: object) -> object

aware_deadline (method)

ExternalCorrelationRequest.aware_deadline(value: datetime | None) -> datetime | None

Release source · Runtime guarantees · Capability guides

`ExternalDeliveryReceipt`

from cayu import ExternalDeliveryReceipt

Bases: _Value.

Fields and attributes

Name	Type	Default
`delivery_id`	`Identifier`	`required`
`content_sha256`	`Digest`	`required`
`accepted_at_ms`	`StrictInt`	`Field(ge=0)`
`disposition`	`Literal['accepted', 'additional', 'late', 'settled', 'unavailable']`	`required`

clean_strings (method)

ExternalDeliveryReceipt.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalEventDelivery`

from cayu import ExternalEventDelivery

Bases: _Value.

Fields and attributes

Name	Type	Default
`correlation`	`ExternalCorrelation`	`required`
`delivery_id`	`Identifier`	`required`
`payload_json`	`StrictStr`	`required`

clean_strings (method)

ExternalEventDelivery.clean_strings(value: object) -> object

bounded_payload (method)

ExternalEventDelivery.bounded_payload(value: str) -> str

Release source · Runtime guarantees · Capability guides

`ExternalWaitCapacityExceeded`

from cayu import ExternalWaitCapacityExceeded

Optional work cannot fit without consuming reserved settlement capacity.

Bases: RuntimeError.

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

Release source · Runtime guarantees · Capability guides

`ExternalWaitConflict`

from cayu import ExternalWaitConflict

An exact operation conflicts with retained evidence.

Bases: ValueError.

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

Release source · Runtime guarantees · Capability guides

`ExternalWaitLimits`

from cayu import ExternalWaitLimits

Bases: _Value.

Fields and attributes

Name	Type	Default
`correlations`	`StrictInt`	`Field(default=EXTERNAL_WAIT_CORRELATIONS, ge=1, le=4096)`
`retained_bytes`	`StrictInt`	`Field(default=EXTERNAL_WAIT_SCOPE_BYTES, ge=131072, le=33554432)`
`deliveries`	`StrictInt`	`Field(default=EXTERNAL_WAIT_DELIVERIES, ge=1, le=32)`
`payload_bytes`	`StrictInt`	`Field(default=EXTERNAL_WAIT_PAYLOAD_BYTES, ge=1, le=65536)`
`projection_bytes`	`StrictInt`	`Field(default=EXTERNAL_WAIT_PAYLOAD_BYTES, ge=1, le=65536)`

clean_strings (method)

ExternalWaitLimits.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalWaitOutcome`

from cayu import ExternalWaitOutcome

Bases: _Value.

Fields and attributes

Name	Type	Default
`kind`	`OutcomeKind`	`required`
`selected_at_ms`	`StrictInt`	`Field(ge=0)`
`delivery_id`	`Identifier \| None`	`None`
`payload_json`	`StrictStr \| None`	`None`
`content_sha256`	`Digest \| None`	`None`

clean_strings (method)

ExternalWaitOutcome.clean_strings(value: object) -> object

coherent_payload (method)

ExternalWaitOutcome.coherent_payload() -> ExternalWaitOutcome

Release source · Runtime guarantees · Capability guides

`ExternalWaitPruneResult`

from cayu import ExternalWaitPruneResult

Bases: _Value.

Fields and attributes

Name	Type	Default
`retirement`	`ExternalWaitRetirement`	`required`
`removed`	`StrictInt`	`Field(ge=0, le=EXTERNAL_WAIT_PAGE_LIMIT)`
`remaining`	`StrictInt`	`Field(ge=0, le=EXTERNAL_WAIT_CORRELATIONS)`

clean_strings (method)

ExternalWaitPruneResult.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalWaitRegistration`

from cayu import ExternalWaitRegistration

Bases: _Value.

Fields and attributes

Name	Type	Default
`correlation`	`ExternalCorrelation`	`required`
`operation_key`	`Identifier`	`required`
`projector_id`	`Identifier`	`required`
`projector_version`	`StrictInt`	`Field(ge=1, le=9007199254740991)`

clean_strings (method)

ExternalWaitRegistration.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalWaitRetirement`

from cayu import ExternalWaitRetirement

Bases: _Value.

Fields and attributes

Name	Type	Default
`request`	`ExternalWaitRetirementRequest`	`required`
`retired_at_ms`	`StrictInt`	`Field(ge=0, le=9007199254740991)`
`correlation_count`	`StrictInt`	`Field(ge=0, le=EXTERNAL_WAIT_CORRELATIONS)`
`records_sha256`	`Digest`	`required`

clean_strings (method)

ExternalWaitRetirement.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalWaitRetirementRequest`

from cayu import ExternalWaitRetirementRequest

Bases: _Value.

Fields and attributes

Name	Type	Default
`scope`	`ExternalWaitScope`	`required`
`operation_key`	`Identifier`	`required`
`limits`	`ExternalWaitLimits`	`required`

clean_strings (method)

ExternalWaitRetirementRequest.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalWaitScope`

from cayu import ExternalWaitScope

Bases: _Value.

Fields and attributes

Name	Type	Default
`application_scope`	`Identifier`	`required`
`generation`	`StrictInt`	`Field(ge=1, le=9007199254740991)`

clean_strings (method)

ExternalWaitScope.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalWaitTimer`

from cayu import ExternalWaitTimer

Immutable managed-task hint; never authority to elect or execute a wait.

Bases: _Value.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`1`
`scheduler_id`	`Identifier`	`required`
`correlation`	`ExternalCorrelation`	`required`
`registration_sha256`	`Digest`	`required`
`task_id`	`Identifier`	`required`

clean_strings (method)

ExternalWaitTimer.clean_strings(value: object) -> object

Release source · Runtime guarantees · Capability guides

`ExternalWaitUnavailable`

from cayu import ExternalWaitUnavailable

No positive receiving evidence is available; this is not exclusion.

Bases: RuntimeError.

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

Release source · Runtime guarantees · Capability guides