iter_describe_groups ¶

iter_describe_groups(
    search_query: SearchQueryType,
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    organization_id: Optional[IdType] = None,
    marker: Optional[MarkerType] = None,
    limit: Optional[PositiveIntegerType] = None,
) -> Iterator[GroupMetadata]

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

def iter_describe_groups(
    self,
    search_query: "capo_workdocs.types.search_query_type.SearchQueryType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    organization_id: Optional["capo_workdocs.types.id_type.IdType"] = None,
    marker: Optional["capo_workdocs.types.marker_type.MarkerType"] = None,
    limit: Optional[
        "capo_workdocs.types.positive_integer_type.PositiveIntegerType"
    ] = None,
) -> "Iterator[capo_workdocs.types.group_metadata.GroupMetadata]":
    _token = marker
    while True:
        _response = self.describe_groups(
            search_query,
            config_overrides=config_overrides,
            authentication_token=authentication_token,
            organization_id=organization_id,
            marker=_token,
            limit=limit,
        )
        _page = _resolve_path(_response, ("groups",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break