SearchFilter class

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 Values1

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 Values1) OR (Attribute Operator Values2) 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.

  • @JsonSerializable(includeIfNull: false, explicitToJson: true, createFactory: false, createToJson: true)


SearchFilter({String attribute, String operator, List<String> values})


attribute String
The result attribute to which the filter values are applied. Valid values vary by API action.
@JsonKey(name: 'Attribute'), final
hashCode int
The hash code for this object. [...]
read-only, inherited
operator String
The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.
@JsonKey(name: 'Operator'), final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
values List<String>
The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.
@JsonKey(name: 'Values'), final


noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toJson() Map<String, dynamic>
toString() String
A string representation of this object. [...]


operator ==(Object other) bool
The equality operator. [...]