class documentation

class PutResult:

View In Hierarchy

The outcome of Client.put, accounting for every entity submitted.

Each submitted entity is counted in exactly one of loaded, failed or timed_out.

Instance Variable failed Entities that were not written, with the reason for each.
Instance Variable loaded The number of entities the API confirmed as written.
Instance Variable timed_out IDs of entities whose request timed out (HTTP 504). The write may or may not have completed server-side: verify with a read, or resubmit them (writes are idempotent upserts).
Property ok True when every submitted entity was confirmed as written.
failed: list[FailedWrite] =

Entities that were not written, with the reason for each.

loaded: int =

The number of entities the API confirmed as written.

timed_out: list[str | None] =

IDs of entities whose request timed out (HTTP 504). The write may or may not have completed server-side: verify with a read, or resubmit them (writes are idempotent upserts).

@property
ok: bool =

True when every submitted entity was confirmed as written.