Meta

Module: iqm.station_control.interface.list_with_meta

class Meta(*, count=None, order_by=None, limit=None, offset=None, errors=None)

Bases: object

Class holding metadata for list return values, including pagination and query statistics.

Attributes

count	Total number of items existing in the storage that match the query criteria.
errors	List of error messages encountered during the execution of the query.
limit	Maximum number of items returned in this query response (page size).
offset	Number of items to skip from the beginning of the result sequence.
order_by	Ordering rule applied to the queried items (e.g., "-created_timestamp" for descending).

Methods

Parameters:

• count (int | None)

• order_by (str | None)

• limit (int | None)

• offset (int | None)

• errors (list[str] | None)

count: int | None = None

Total number of items existing in the storage that match the query criteria.

order_by: str | None = None

Ordering rule applied to the queried items (e.g., “-created_timestamp” for descending).

limit: int | None = None

Maximum number of items returned in this query response (page size).

If set to 0 or a negative integer, pagination is disabled and the query attempts to return all available records (matching count - offset). Note: Disabling the limit may result in extremely heavy database and network load.

offset: int | None = None

Number of items to skip from the beginning of the result sequence.

This value can be incremented in successive queries to loop through pages until count is reached.

errors: list[str] | None = None

List of error messages encountered during the execution of the query.

Inheritance