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

Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse

Description

Synopsis

data PropertyDefinitionResponse = PropertyDefinitionResponse' {
- configuration :: Maybe (HashMap Text Text)
- defaultValue :: Maybe DataValue
- displayName :: Maybe Text
- dataType :: DataType
- isTimeSeries :: Bool
- isRequiredInEntity :: Bool
- isExternalId :: Bool
- isStoredExternally :: Bool
- isImported :: Bool
- isFinal :: Bool
- isInherited :: Bool
}
newPropertyDefinitionResponse :: DataType -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> PropertyDefinitionResponse
propertyDefinitionResponse_configuration :: Lens' PropertyDefinitionResponse (Maybe (HashMap Text Text))
propertyDefinitionResponse_defaultValue :: Lens' PropertyDefinitionResponse (Maybe DataValue)
propertyDefinitionResponse_displayName :: Lens' PropertyDefinitionResponse (Maybe Text)
propertyDefinitionResponse_dataType :: Lens' PropertyDefinitionResponse DataType
propertyDefinitionResponse_isTimeSeries :: Lens' PropertyDefinitionResponse Bool
propertyDefinitionResponse_isRequiredInEntity :: Lens' PropertyDefinitionResponse Bool
propertyDefinitionResponse_isExternalId :: Lens' PropertyDefinitionResponse Bool
propertyDefinitionResponse_isStoredExternally :: Lens' PropertyDefinitionResponse Bool
propertyDefinitionResponse_isImported :: Lens' PropertyDefinitionResponse Bool
propertyDefinitionResponse_isFinal :: Lens' PropertyDefinitionResponse Bool
propertyDefinitionResponse_isInherited :: Lens' PropertyDefinitionResponse Bool

Documentation

data PropertyDefinitionResponse Source #

An object that contains response data from a property definition request.

See: newPropertyDefinitionResponse smart constructor.

Constructors

PropertyDefinitionResponse'

Fields

configuration :: Maybe (HashMap Text Text)
A mapping that specifies configuration information about the property.
defaultValue :: Maybe DataValue
An object that contains the default value.
displayName :: Maybe Text
A friendly name for the property.
dataType :: DataType
An object that contains information about the data type.
isTimeSeries :: Bool
A Boolean value that specifies whether the property consists of time series data.
isRequiredInEntity :: Bool
A Boolean value that specifies whether the property is required in an entity.
isExternalId :: Bool
A Boolean value that specifies whether the property ID comes from an external data store.
isStoredExternally :: Bool
A Boolean value that specifies whether the property is stored externally.
isImported :: Bool
A Boolean value that specifies whether the property definition is imported from an external data store.
isFinal :: Bool
A Boolean value that specifies whether the property definition can be updated.
isInherited :: Bool
A Boolean value that specifies whether the property definition is inherited from a parent entity.

Instances

Instances details

FromJSON PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse Methods parseJSON :: Value -> Parser PropertyDefinitionResponse # parseJSONList :: Value -> Parser [PropertyDefinitionResponse] #
Generic PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse Associated Types type Rep PropertyDefinitionResponse :: Type -> Type # Methods from :: PropertyDefinitionResponse -> Rep PropertyDefinitionResponse x # to :: Rep PropertyDefinitionResponse x -> PropertyDefinitionResponse #
Read PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse Methods readsPrec :: Int -> ReadS PropertyDefinitionResponse # readList :: ReadS [PropertyDefinitionResponse] # readPrec :: ReadPrec PropertyDefinitionResponse # readListPrec :: ReadPrec [PropertyDefinitionResponse] #
Show PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse Methods showsPrec :: Int -> PropertyDefinitionResponse -> ShowS # show :: PropertyDefinitionResponse -> String # showList :: [PropertyDefinitionResponse] -> ShowS #
NFData PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse Methods rnf :: PropertyDefinitionResponse -> () #
Eq PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse Methods (==) :: PropertyDefinitionResponse -> PropertyDefinitionResponse -> Bool # (/=) :: PropertyDefinitionResponse -> PropertyDefinitionResponse -> Bool #
Hashable PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse Methods hashWithSalt :: Int -> PropertyDefinitionResponse -> Int # hash :: PropertyDefinitionResponse -> Int #
type Rep PropertyDefinitionResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse type Rep PropertyDefinitionResponse = D1 ('MetaData "PropertyDefinitionResponse" "Amazonka.IotTwinMaker.Types.PropertyDefinitionResponse" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "PropertyDefinitionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataValue))) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataType) :: S1 ('MetaSel ('Just "isTimeSeries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))) :: ((S1 ('MetaSel ('Just "isRequiredInEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "isExternalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "isStoredExternally") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: (S1 ('MetaSel ('Just "isImported") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "isFinal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "isInherited") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newPropertyDefinitionResponse Source #

Arguments

:: DataType	`$sel:dataType:PropertyDefinitionResponse'`
-> Bool	`$sel:isTimeSeries:PropertyDefinitionResponse'`
-> Bool	`$sel:isRequiredInEntity:PropertyDefinitionResponse'`
-> Bool	`$sel:isExternalId:PropertyDefinitionResponse'`
-> Bool	`$sel:isStoredExternally:PropertyDefinitionResponse'`
-> Bool	`$sel:isImported:PropertyDefinitionResponse'`
-> Bool	`$sel:isFinal:PropertyDefinitionResponse'`
-> Bool	`$sel:isInherited:PropertyDefinitionResponse'`
-> PropertyDefinitionResponse

Create a value of PropertyDefinitionResponse 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:configuration:PropertyDefinitionResponse', propertyDefinitionResponse_configuration - A mapping that specifies configuration information about the property.

$sel:defaultValue:PropertyDefinitionResponse', propertyDefinitionResponse_defaultValue - An object that contains the default value.

$sel:displayName:PropertyDefinitionResponse', propertyDefinitionResponse_displayName - A friendly name for the property.

$sel:dataType:PropertyDefinitionResponse', propertyDefinitionResponse_dataType - An object that contains information about the data type.

$sel:isTimeSeries:PropertyDefinitionResponse', propertyDefinitionResponse_isTimeSeries - A Boolean value that specifies whether the property consists of time series data.

$sel:isRequiredInEntity:PropertyDefinitionResponse', propertyDefinitionResponse_isRequiredInEntity - A Boolean value that specifies whether the property is required in an entity.

$sel:isExternalId:PropertyDefinitionResponse', propertyDefinitionResponse_isExternalId - A Boolean value that specifies whether the property ID comes from an external data store.

$sel:isStoredExternally:PropertyDefinitionResponse', propertyDefinitionResponse_isStoredExternally - A Boolean value that specifies whether the property is stored externally.

$sel:isImported:PropertyDefinitionResponse', propertyDefinitionResponse_isImported - A Boolean value that specifies whether the property definition is imported from an external data store.

$sel:isFinal:PropertyDefinitionResponse', propertyDefinitionResponse_isFinal - A Boolean value that specifies whether the property definition can be updated.

$sel:isInherited:PropertyDefinitionResponse', propertyDefinitionResponse_isInherited - A Boolean value that specifies whether the property definition is inherited from a parent entity.

propertyDefinitionResponse_configuration :: Lens' PropertyDefinitionResponse (Maybe (HashMap Text Text)) Source #

A mapping that specifies configuration information about the property.

propertyDefinitionResponse_defaultValue :: Lens' PropertyDefinitionResponse (Maybe DataValue) Source #

An object that contains the default value.

propertyDefinitionResponse_displayName :: Lens' PropertyDefinitionResponse (Maybe Text) Source #

A friendly name for the property.

propertyDefinitionResponse_dataType :: Lens' PropertyDefinitionResponse DataType Source #

An object that contains information about the data type.

propertyDefinitionResponse_isTimeSeries :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property consists of time series data.

propertyDefinitionResponse_isRequiredInEntity :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property is required in an entity.

propertyDefinitionResponse_isExternalId :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property ID comes from an external data store.

propertyDefinitionResponse_isStoredExternally :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property is stored externally.

propertyDefinitionResponse_isImported :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property definition is imported from an external data store.

propertyDefinitionResponse_isFinal :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property definition can be updated.

propertyDefinitionResponse_isInherited :: Lens' PropertyDefinitionResponse Bool Source #

A Boolean value that specifies whether the property definition is inherited from a parent entity.