repository.things
repository.things — SyncThingNamespace with the repo bound.
Sync owner: RepositoryClient.things. Async owner: AsyncRepositoryClient.things.
Synchronous methods
Section titled “Synchronous methods”count(*, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, since_repo_seq: int | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See SyncThingFilterMixin.count.
get(wref: str, version: int | Unset = UNSET, *, include_retracted: bool | Unset = UNSET, data_mode: DataMode | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ThingDetail[PayloadT]See SyncThingNamespace.get.
get_many
Section titled “get_many”get_many(wrefs: Sequence[str], version: int | Unset = UNSET, *, include_retracted: bool | Unset = UNSET, data_mode: DataMode | Unset = UNSET, chunk_size: int | Unset = UNSET, chunk_concurrency: int | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingBatchMixin.get_many.
head(*, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, include_retracted: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, since_repo_seq: int | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> HeadResult[PayloadT]See SyncThingNamespace.head.
head_all
Section titled “head_all”head_all(*, max_items: int | Unset = UNSET, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, include_retracted: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> list[ThingItem[PayloadT]]See SyncThingNamespace.head_all.
head_changes
Section titled “head_changes”head_changes(*, since_repo_seq: int, limit: int | Unset = UNSET, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See SyncThingChangesMixin.head_changes.
head_iter
Section titled “head_iter”head_iter(*, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, include_retracted: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> Iterator[ThingItem[PayloadT]]See SyncThingNamespace.head_iter.
head_versions
Section titled “head_versions”head_versions(wrefs: Sequence[str], *, chunk_size: int | Unset = UNSET, chunk_concurrency: int | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingBatchMixin.head_versions.
query(*, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, since_repo_seq: int | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See SyncThingFilterMixin.query.
query_all
Section titled “query_all”query_all(*, max_items: int | Unset = UNSET, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingPaginationMixin.query_all.
query_changes
Section titled “query_changes”query_changes(*, since_repo_seq: int, limit: int | Unset = UNSET, shape: str | Unset = UNSET, about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See SyncThingChangesMixin.query_changes.
query_iter
Section titled “query_iter”query_iter(*, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingPaginationMixin.query_iter.
search
Section titled “search”search(query: str, *, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, mode: SearchMode | Unset = UNSET, name_match: NameMatch | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See SyncThingFilterMixin.search.
Asynchronous methods
Section titled “Asynchronous methods”count(*, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, since_repo_seq: int | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingFilterMixin.count.
get(wref: str, version: int | Unset = UNSET, *, include_retracted: bool | Unset = UNSET, data_mode: DataMode | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> ThingDetail[PayloadT]See AsyncThingNamespace.get.
get_many
Section titled “get_many”get_many(wrefs: Sequence[str], version: int | Unset = UNSET, *, include_retracted: bool | Unset = UNSET, data_mode: DataMode | Unset = UNSET, chunk_size: int | Unset = UNSET, chunk_concurrency: int | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingBatchMixin.get_many.
head(*, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, include_retracted: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, since_repo_seq: int | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> HeadResult[PayloadT]See AsyncThingNamespace.head.
head_all
Section titled “head_all”head_all(*, max_items: int | Unset = UNSET, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, include_retracted: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> list[ThingItem[PayloadT]]See AsyncThingNamespace.head_all.
head_changes
Section titled “head_changes”head_changes(*, since_repo_seq: int, limit: int | Unset = UNSET, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingChangesMixin.head_changes.
head_iter
Section titled “head_iter”head_iter(*, shape: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, data_mode: DataMode | Unset = UNSET, include_retracted: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> AsyncIterator[ThingItem[PayloadT]]See AsyncThingNamespace.head_iter.
head_versions
Section titled “head_versions”head_versions(wrefs: Sequence[str], *, chunk_size: int | Unset = UNSET, chunk_concurrency: int | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingBatchMixin.head_versions.
query(*, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, since_repo_seq: int | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingFilterMixin.query.
query_all
Section titled “query_all”query_all(*, max_items: int | Unset = UNSET, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingPaginationMixin.query_all.
query_changes
Section titled “query_changes”query_changes(*, since_repo_seq: int, limit: int | Unset = UNSET, shape: str | Unset = UNSET, about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingChangesMixin.query_changes.
query_iter
Section titled “query_iter”query_iter(*, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, role: CollectionRole | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, where: Sequence[WherePredicate] | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingPaginationMixin.query_iter.
search
Section titled “search”search(query: str, *, shape: str | Unset = UNSET, about: str | Unset = UNSET, affirmed_about: str | Unset = UNSET, kind: ThingKind | Unset = UNSET, match: str | Unset = UNSET, include_retracted: bool | Unset = UNSET, resolve_collections: bool | Unset = UNSET, limit: int | Unset = UNSET, cursor: str | Unset = UNSET, component_ref: str | Unset = UNSET, exclude_components: bool | Unset = UNSET, exclude_infra_shapes: bool | Unset = UNSET, mode: SearchMode | Unset = UNSET, name_match: NameMatch | Unset = UNSET, decode_as: type[PayloadT] | Unset = UNSET, decoder: PayloadDecoder[PayloadT] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)See AsyncThingFilterMixin.search.