QueryResponses¶
- pydantic model openapi_client.models.query_responses.QueryResponses¶
Paginated envelope returned by GET /queries. Sorting and paging are performed in-process over the caller’s whole query set, so total_count is the size of that full set while count is the size of this page only.
- Fields:
- field query_items: List[QueryResponse] [Required]¶
Queries on the current page.
- field next_available: StrictStr [Required]¶
Whether a further page exists. “yes” means more records remain, so request the next page by advancing offset by limit. “no” means this is the last page and the client must stop iterating.
- Constraints:
strict = True
- field count: StrictInt [Required]¶
Number of items returned in query_items on this page.
- Constraints:
strict = True
- field total_count: StrictInt [Required]¶
Total number of queries available across all pages.
- Constraints:
strict = True
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of QueryResponses from a JSON string
- Return type:
Optional[Self]
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True):
None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- Return type:
Dict[str,Any]
- classmethod from_dict(obj)¶
Create an instance of QueryResponses from a dict
- Return type:
Optional[Self]