Sorting

Some operations can have their results sorted by the value of their fields. These helper data structures are used to define the desired order.

class Ordering(value)

Specifies in what order a field should be sorted by.

ASC = 'asc'

The order of the field should be ascending (from low to high)

DESC = 'desc'

The order of the field should be descending (from high to low)

class SortOptions(field_name: str, ordering: brainframe.api.bf_codecs.sorting.Ordering)

A sorting configuration. Used by some APIs that provide many of a certain object.

field_name: str

The name of the field to sort by

ordering: Ordering

The order to sort the field by