SearchFilter

Describes criteria to restrict a list of results.

For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]

Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The result attribute to which the filter values are applied. Valid values vary by API action.

Link copied to clipboard

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Link copied to clipboard

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Functions

Link copied to clipboard
inline fun copy(block: SearchFilter.Builder.() -> Unit = {}): SearchFilter
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String