client.collection
Generated methods for the collection namespace.
Sync owner: WarmHubClient.collection. Async owner: AsyncWarmHubClient.collection.
Synchronous methods
Section titled “Synchronous methods”contains
Section titled “contains”contains(org_name: str, repo_name: str, wref: str, members: Sequence[str], *, version: float | Unset = UNSET, position: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionContainsResultcollection.contains — query collection.contains.
create
Section titled “create”create(org_name: str, repo_name: str, *, event_request_id: str, type: Literal['arc', 'bond', 'pair', 'set', 'list'], name: str, members: Sequence[str] | Unset = UNSET, from_: str | Unset = UNSET, add: Sequence[str] | Unset = UNSET, remove: Sequence[str] | Unset = UNSET, replace_members: Sequence[str] | Unset = UNSET, query: Mapping[str, JsonValue] | Unset = UNSET, source_repo: Mapping[str, JsonValue] | Unset = UNSET, skip_existing: bool | Unset = UNSET, message: str | Unset = UNSET, committer: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionMutationCompatibilityResult0 | CollectionMutationCompatibilityResult1collection.create — mutate collection.create.
diff(org_name: str, repo_name: str, left_wref: str, right_wref: str, *, left_version: float | Unset = UNSET, right_version: float | Unset = UNSET, mode: Literal['auto', 'membership', 'ordered'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionDiffResultcollection.diff — query collection.diff.
members
Section titled “members”members(org_name: str, repo_name: str, wref: str, *, version: float | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionMembersPagecollection.members — query collection.members.
members_all
Section titled “members_all”members_all(org_name: str, repo_name: str, wref: str, *, max_items: int | Unset = UNSET, version: int | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)Materialize every member of the collection.
max_items carries the same observed-item semantics as
SyncThingPaginationMixin.query_all. Every page after the first
is pinned to the first page’s version.
members_iter
Section titled “members_iter”members_iter(org_name: str, repo_name: str, wref: str, *, version: int | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)Every member of the collection, page by page. for m in ....
A plain generator-backed iterator: there is nothing to await here, which is the one shape difference from the async twin.
Every page after the first is pinned to the first page’s version. See the async module’s docstring for why.
revise
Section titled “revise”revise(org_name: str, repo_name: str, wref: str, *, event_request_id: str, members: Sequence[str] | Unset = UNSET, add: Sequence[str] | Unset = UNSET, remove: Sequence[str] | Unset = UNSET, query: Mapping[str, JsonValue] | Unset = UNSET, source_repo: Mapping[str, JsonValue] | Unset = UNSET, message: str | Unset = UNSET, committer: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)collection.revise — mutate collection.revise.
See
AsyncGeneratedCollectionReviseMixin.revise.
stats(org_name: str, repo_name: str, wref: str, *, version: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionStatsResultcollection.stats — query collection.stats.
Asynchronous methods
Section titled “Asynchronous methods”contains
Section titled “contains”contains(org_name: str, repo_name: str, wref: str, members: Sequence[str], *, version: float | Unset = UNSET, position: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionContainsResultcollection.contains — query collection.contains.
create
Section titled “create”create(org_name: str, repo_name: str, *, event_request_id: str, type: Literal['arc', 'bond', 'pair', 'set', 'list'], name: str, members: Sequence[str] | Unset = UNSET, from_: str | Unset = UNSET, add: Sequence[str] | Unset = UNSET, remove: Sequence[str] | Unset = UNSET, replace_members: Sequence[str] | Unset = UNSET, query: Mapping[str, JsonValue] | Unset = UNSET, source_repo: Mapping[str, JsonValue] | Unset = UNSET, skip_existing: bool | Unset = UNSET, message: str | Unset = UNSET, committer: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionMutationCompatibilityResult0 | CollectionMutationCompatibilityResult1collection.create — mutate collection.create.
diff(org_name: str, repo_name: str, left_wref: str, right_wref: str, *, left_version: float | Unset = UNSET, right_version: float | Unset = UNSET, mode: Literal['auto', 'membership', 'ordered'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionDiffResultcollection.diff — query collection.diff.
members
Section titled “members”members(org_name: str, repo_name: str, wref: str, *, version: float | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionMembersPagecollection.members — query collection.members.
members_all
Section titled “members_all”members_all(org_name: str, repo_name: str, wref: str, *, max_items: int | Unset = UNSET, version: int | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)Materialize every member of the collection.
max_items carries the same observed-item semantics as
AsyncThingPaginationMixin.query_all. Every page after the first
is pinned to the first page’s version.
members_iter
Section titled “members_iter”members_iter(org_name: str, repo_name: str, wref: str, *, version: int | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)Every member of the collection, page by page. async for m in ....
A non-async factory returning an async iterator, so async for over the
call works without an await first.
Every page after the first is pinned to the first page’s version. See the module docstring for why.
revise
Section titled “revise”revise(org_name: str, repo_name: str, wref: str, *, event_request_id: str, members: Sequence[str] | Unset = UNSET, add: Sequence[str] | Unset = UNSET, remove: Sequence[str] | Unset = UNSET, query: Mapping[str, JsonValue] | Unset = UNSET, source_repo: Mapping[str, JsonValue] | Unset = UNSET, message: str | Unset = UNSET, committer: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)collection.revise — mutate collection.revise.
Rejects an unanchored selector, a source_repo without one, a
source_repo combined with explicit members, and a selector-backed
revise aimed at a non-Set wref — all before anything is sent.
stats(org_name: str, repo_name: str, wref: str, *, version: float | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CollectionStatsResultcollection.stats — query collection.stats.