Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTThingsGraph.Types.EntityFilter

Description

Synopsis

data EntityFilter = EntityFilter' {
- value :: Maybe [Text]
- name :: Maybe EntityFilterName
}
newEntityFilter :: EntityFilter
entityFilter_value :: Lens' EntityFilter (Maybe [Text])
entityFilter_name :: Lens' EntityFilter (Maybe EntityFilterName)

Documentation

data EntityFilter Source #

An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

See: newEntityFilter smart constructor.

Constructors

EntityFilter'
Fields value :: Maybe [Text] An array of string values for the search filter field. Multiple values function as AND criteria in the search. name :: Maybe EntityFilterName The name of the entity search filter field. `REFERENCED_ENTITY_ID` filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Instances

Instances details

Eq EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter Methods (==) :: EntityFilter -> EntityFilter -> Bool # (/=) :: EntityFilter -> EntityFilter -> Bool #
Read EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter Methods readsPrec :: Int -> ReadS EntityFilter # readList :: ReadS [EntityFilter] # readPrec :: ReadPrec EntityFilter # readListPrec :: ReadPrec [EntityFilter] #
Show EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter Methods showsPrec :: Int -> EntityFilter -> ShowS # show :: EntityFilter -> String # showList :: [EntityFilter] -> ShowS #
Generic EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter Associated Types type Rep EntityFilter :: Type -> Type # Methods from :: EntityFilter -> Rep EntityFilter x # to :: Rep EntityFilter x -> EntityFilter #
NFData EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter Methods rnf :: EntityFilter -> () #
Hashable EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter Methods hashWithSalt :: Int -> EntityFilter -> Int # hash :: EntityFilter -> Int #
ToJSON EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter Methods toJSON :: EntityFilter -> Value # toEncoding :: EntityFilter -> Encoding # toJSONList :: [EntityFilter] -> Value # toEncodingList :: [EntityFilter] -> Encoding #
type Rep EntityFilter Source #
Instance details Defined in Amazonka.IoTThingsGraph.Types.EntityFilter type Rep EntityFilter = D1 ('MetaData "EntityFilter" "Amazonka.IoTThingsGraph.Types.EntityFilter" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "EntityFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityFilterName))))

newEntityFilter :: EntityFilter Source #

Create a value of EntityFilter 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:value:EntityFilter', entityFilter_value - An array of string values for the search filter field. Multiple values function as AND criteria in the search.

$sel:name:EntityFilter', entityFilter_name - The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

entityFilter_value :: Lens' EntityFilter (Maybe [Text]) Source #

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

entityFilter_name :: Lens' EntityFilter (Maybe EntityFilterName) Source #

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.