new module:models/TermFilter(field, operator)
Constructs a new TermFilter.
Document representing a term filter.
Parameters:
| Name | Type | Description |
|---|---|---|
field |
String | The filter field. |
operator |
module:models/TermFilter.OperatorEnum | The operator to compare the field's values with the given ones. |
- Source:
Members
(readonly) OperatorEnum :String
Allowed values for the operator property.
Type:
- String
- Source:
(inner) field :String
The filter field.
Type:
- String
- Source:
(inner, constant) greater
value: "greater"
- Source:
(inner, constant) is
value: "is"
- Source:
(inner, constant) is_not_null
value: "is_not_null"
- Source:
(inner, constant) is_null
value: "is_null"
- Source:
(inner, constant) less
value: "less"
- Source:
(inner, constant) neq
value: "neq"
- Source:
(inner, constant) not_in
value: "not_in"
- Source:
(inner, constant) one_of
value: "one_of"
- Source:
(inner) operator :module:models/TermFilter.OperatorEnum
The operator to compare the field's values with the given ones.
Type:
- module:models/TermFilter.OperatorEnum
- Source:
(inner) values :Array.<Object>
The filter values.
Type:
- Array.<Object>
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/TermFilter}
Constructs a TermFilter from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/TermFilter | Optional instance to populate. |
- Source:
Returns:
The populated TermFilter instance.