Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data AttributeFilter = AttributeFilter' {
- andAllFilters :: Maybe [AttributeFilter]
- containsAll :: Maybe DocumentAttribute
- containsAny :: Maybe DocumentAttribute
- equalsTo :: Maybe DocumentAttribute
- greaterThan :: Maybe DocumentAttribute
- greaterThanOrEquals :: Maybe DocumentAttribute
- lessThan :: Maybe DocumentAttribute
- lessThanOrEquals :: Maybe DocumentAttribute
- notFilter :: Maybe AttributeFilter
- orAllFilters :: Maybe [AttributeFilter]
- newAttributeFilter :: AttributeFilter
- attributeFilter_andAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter])
- attributeFilter_containsAll :: Lens' AttributeFilter (Maybe DocumentAttribute)
- attributeFilter_containsAny :: Lens' AttributeFilter (Maybe DocumentAttribute)
- attributeFilter_equalsTo :: Lens' AttributeFilter (Maybe DocumentAttribute)
- attributeFilter_greaterThan :: Lens' AttributeFilter (Maybe DocumentAttribute)
- attributeFilter_greaterThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute)
- attributeFilter_lessThan :: Lens' AttributeFilter (Maybe DocumentAttribute)
- attributeFilter_lessThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute)
- attributeFilter_notFilter :: Lens' AttributeFilter (Maybe AttributeFilter)
- attributeFilter_orAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter])
Documentation
data AttributeFilter Source #
Provides filtering the query results based on document attributes or metadata fields.
When you use the AndAllFilters
or OrAllFilters
, filters you can use
2 layers under the first attribute filter. For example, you can use:
<AndAllFilters>
<OrAllFilters>
<EqualsTo>
If you use more than 2 layers, you receive a ValidationException
exception with the message "AttributeFilter
cannot have a depth of
more than 2."
If you use more than 10 attribute filters in a given list for
AndAllFilters
or OrAllFilters
, you receive a ValidationException
with the message "AttributeFilter
cannot have a length of more than
10".
See: newAttributeFilter
smart constructor.
AttributeFilter' | |
|
Instances
newAttributeFilter :: AttributeFilter Source #
Create a value of AttributeFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:andAllFilters:AttributeFilter'
, attributeFilter_andAllFilters
- Performs a logical AND
operation on all supplied filters.
$sel:containsAll:AttributeFilter'
, attributeFilter_containsAll
- Returns true when a document contains all of the specified document
attributes or metadata fields. This filter is only applicable to
StringListValue
metadata.
$sel:containsAny:AttributeFilter'
, attributeFilter_containsAny
- Returns true when a document contains any of the specified document
attributes or metadata fields. This filter is only applicable to
StringListValue
metadata.
$sel:equalsTo:AttributeFilter'
, attributeFilter_equalsTo
- Performs an equals operation on two document attributes or metadata
fields.
$sel:greaterThan:AttributeFilter'
, attributeFilter_greaterThan
- Performs a greater than operation on two document attributes or metadata
fields. Use with a document attribute of type Date
or Long
.
$sel:greaterThanOrEquals:AttributeFilter'
, attributeFilter_greaterThanOrEquals
- Performs a greater or equals than operation on two document attributes
or metadata fields. Use with a document attribute of type Date
or
Long
.
$sel:lessThan:AttributeFilter'
, attributeFilter_lessThan
- Performs a less than operation on two document attributes or metadata
fields. Use with a document attribute of type Date
or Long
.
$sel:lessThanOrEquals:AttributeFilter'
, attributeFilter_lessThanOrEquals
- Performs a less than or equals operation on two document attributes or
metadata fields. Use with a document attribute of type Date
or Long
.
$sel:notFilter:AttributeFilter'
, attributeFilter_notFilter
- Performs a logical NOT
operation on all supplied filters.
$sel:orAllFilters:AttributeFilter'
, attributeFilter_orAllFilters
- Performs a logical OR
operation on all supplied filters.
attributeFilter_andAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter]) Source #
Performs a logical AND
operation on all supplied filters.
attributeFilter_containsAll :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #
Returns true when a document contains all of the specified document
attributes or metadata fields. This filter is only applicable to
StringListValue
metadata.
attributeFilter_containsAny :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #
Returns true when a document contains any of the specified document
attributes or metadata fields. This filter is only applicable to
StringListValue
metadata.
attributeFilter_equalsTo :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #
Performs an equals operation on two document attributes or metadata fields.
attributeFilter_greaterThan :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #
Performs a greater than operation on two document attributes or metadata
fields. Use with a document attribute of type Date
or Long
.
attributeFilter_greaterThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #
Performs a greater or equals than operation on two document attributes
or metadata fields. Use with a document attribute of type Date
or
Long
.
attributeFilter_lessThan :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #
Performs a less than operation on two document attributes or metadata
fields. Use with a document attribute of type Date
or Long
.
attributeFilter_lessThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #
Performs a less than or equals operation on two document attributes or
metadata fields. Use with a document attribute of type Date
or Long
.
attributeFilter_notFilter :: Lens' AttributeFilter (Maybe AttributeFilter) Source #
Performs a logical NOT
operation on all supplied filters.
attributeFilter_orAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter]) Source #
Performs a logical OR
operation on all supplied filters.