Qbusiness  >  Structures  >  AttributeFilter

AttributeFilter

Structure Class

AttributeFilter dataclass

Enables filtering of responses based on document attributes or metadata fields.

Attributes

and_all_filters class-attribute instance-attribute

and_all_filters: list[AttributeFilter] | None = None

Performs a logical AND operation on all supplied filters.

contains_all class-attribute instance-attribute

contains_all: DocumentAttribute | None = None

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

contains_any class-attribute instance-attribute

contains_any: DocumentAttribute | None = None

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

equals_to class-attribute instance-attribute

equals_to: DocumentAttribute | None = None

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

greater_than class-attribute instance-attribute

greater_than: DocumentAttribute | None = None

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

greater_than_or_equals class-attribute instance-attribute

greater_than_or_equals: DocumentAttribute | None = None

Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

less_than class-attribute instance-attribute

less_than: DocumentAttribute | None = None

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

less_than_or_equals class-attribute instance-attribute

less_than_or_equals: DocumentAttribute | None = None

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

not_filter class-attribute instance-attribute

not_filter: AttributeFilter | None = None

Performs a logical NOT operation on all supplied filters.

or_all_filters class-attribute instance-attribute

or_all_filters: list[AttributeFilter] | None = None

Performs a logical OR operation on all supplied filters.