Skip to main content

SchemaFilter

This class provides a mechanism for filtering schema elements based on explicit inclusion and exclusion sets. It allows for fine-grained control over which components are processed or returned by checking against defined hash sets of allowed or restricted items.

Attributes

AttributeTypeDescription
includeOption< Box< AHashSet< T > > >An optional set of specific schema elements to be included during the filtering process.
excludeOption< Box< AHashSet< T > > >An optional set of specific schema elements to be explicitly omitted during the filtering process.

Constructor

Signature

def SchemaFilter(
include: Option< Box< AHashSet< T > > > = null,
exclude: Option< Box< AHashSet< T > > > = null
) - > null

Parameters

NameTypeDescription
includeOption< Box< AHashSet< T > > > = nullAn optional set of items to be included in the filter.
excludeOption< Box< AHashSet< T > > > = nullAn optional set of items to be excluded from the filter.

Signature

@staticmethod
def new(
include: Option< Box< AHashSet< T > > >,
exclude: Option< Box< AHashSet< T > > >
) - > [SchemaFilter](schemafilter.md?sid=serializers_filter_schemafilter)

Parameters

NameTypeDescription
includeOption< Box< AHashSet< T > > >An optional set of schema identifiers that should be explicitly included; if provided, only these schemas will be processed.
excludeOption< Box< AHashSet< T > > >An optional set of schema identifiers that should be explicitly ignored or skipped during processing.