toloka.client.TolokaClient.get_user_restrictions | Source code
Finds all Toloker restrictions that match certain criteria.
get_user_restrictions returns a generator. You can iterate over all found Toloker restrictions using the generator. Several requests to the Toloka server are possible while iterating.
If you need to sort Toloker restrictions use the find_user_restrictions method.
| Parameters | Type | Description |
|---|---|---|
scope | Optional[UserRestriction.Scope] | The scope of a restriction. Refer to the UserRestriction.Scope page for more information on the available |
user_id | Optional[str] | The Toloker's ID. |
project_id | Optional[str] | The ID of a project with restricted access. |
pool_id | Optional[str] | The ID of a pool with restricted access. |
id_lt | Optional[str] | Restrictions with IDs less than the specified value. |
id_lte | Optional[str] | Restrictions with IDs less than or equal to the specified value. |
id_gt | Optional[str] | Restrictions with IDs greater than the specified value. |
id_gte | Optional[str] | Restrictions with IDs greater than or equal to the specified value. |
created_lt | Optional[datetime] | Restrictions created before the specified date. |
created_lte | Optional[datetime] | Restrictions created before or on the specified date. |
created_gt | Optional[datetime] | Restrictions created after the specified date. |
created_gte | Optional[datetime] | Restrictions created after or on the specified date. |
batch_size | Optional[int] | A limit of items returned by each request to Toloka. The maximum allowed value: 500. |
Yields:
The next matching Toloker restriction.
Yield type:
Generator[UserRestriction, None, None]
Examples:
restrictions = list(toloka_client.get_user_restrictions(scope='ALL_PROJECTS'))Last updated: August 28, 2023