iter_search_resources `async` ¶

iter_search_resources(
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    query_text: Optional[SearchQueryType] = None,
    query_scopes: Optional[SearchQueryScopeTypeList] = None,
    organization_id: Optional[IdType] = None,
    additional_response_fields: Optional[AdditionalResponseFieldsList] = None,
    filters: Optional[Filters] = None,
    order_by: Optional[SearchResultSortList] = None,
    limit: Optional[SearchResultsLimitType] = None,
    marker: Optional[NextMarkerType] = None,
) -> AsyncIterator[ResponseItem]

Source code in docs_src/capo_workdocs/_services/async_work_docs.py

async def iter_search_resources(
    self,
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    query_text: Optional[
        "capo_workdocs.types.search_query_type.SearchQueryType"
    ] = None,
    query_scopes: Optional[
        "capo_workdocs.types.search_query_scope_type_list.SearchQueryScopeTypeList"
    ] = None,
    organization_id: Optional["capo_workdocs.types.id_type.IdType"] = None,
    additional_response_fields: Optional[
        "capo_workdocs.types.additional_response_fields_list.AdditionalResponseFieldsList"
    ] = None,
    filters: Optional["capo_workdocs.types.filters.Filters"] = None,
    order_by: Optional[
        "capo_workdocs.types.search_result_sort_list.SearchResultSortList"
    ] = None,
    limit: Optional[
        "capo_workdocs.types.search_results_limit_type.SearchResultsLimitType"
    ] = None,
    marker: Optional["capo_workdocs.types.next_marker_type.NextMarkerType"] = None,
) -> "AsyncIterator[capo_workdocs.types.response_item.ResponseItem]":
    _token = marker
    while True:
        _response = await self.search_resources(
            config_overrides=config_overrides,
            authentication_token=authentication_token,
            query_text=query_text,
            query_scopes=query_scopes,
            organization_id=organization_id,
            additional_response_fields=additional_response_fields,
            filters=filters,
            order_by=order_by,
            limit=limit,
            marker=_token,
        )
        _page = _resolve_path(_response, ("items",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break

iter_search_resources async ¶

iter_search_resources `async` ¶