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.PropertyDefinitionRequest

Description

Synopsis

data PropertyDefinitionRequest = PropertyDefinitionRequest' {
- configuration :: Maybe (HashMap Text Text)
- dataType :: Maybe DataType
- defaultValue :: Maybe DataValue
- displayName :: Maybe Text
- isExternalId :: Maybe Bool
- isRequiredInEntity :: Maybe Bool
- isStoredExternally :: Maybe Bool
- isTimeSeries :: Maybe Bool
}
newPropertyDefinitionRequest :: PropertyDefinitionRequest
propertyDefinitionRequest_configuration :: Lens' PropertyDefinitionRequest (Maybe (HashMap Text Text))
propertyDefinitionRequest_dataType :: Lens' PropertyDefinitionRequest (Maybe DataType)
propertyDefinitionRequest_defaultValue :: Lens' PropertyDefinitionRequest (Maybe DataValue)
propertyDefinitionRequest_displayName :: Lens' PropertyDefinitionRequest (Maybe Text)
propertyDefinitionRequest_isExternalId :: Lens' PropertyDefinitionRequest (Maybe Bool)
propertyDefinitionRequest_isRequiredInEntity :: Lens' PropertyDefinitionRequest (Maybe Bool)
propertyDefinitionRequest_isStoredExternally :: Lens' PropertyDefinitionRequest (Maybe Bool)
propertyDefinitionRequest_isTimeSeries :: Lens' PropertyDefinitionRequest (Maybe Bool)

Documentation

data PropertyDefinitionRequest Source #

An object that sets information about a property.

See: newPropertyDefinitionRequest smart constructor.

Constructors

PropertyDefinitionRequest'

Fields

configuration :: Maybe (HashMap Text Text)
A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
dataType :: Maybe DataType
An object that contains information about the data type.
defaultValue :: Maybe DataValue
An object that contains the default value.
displayName :: Maybe Text
A friendly name for the property.
isExternalId :: Maybe Bool
A Boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity :: Maybe Bool
A Boolean value that specifies whether the property is required.
isStoredExternally :: Maybe Bool
A Boolean value that specifies whether the property is stored externally.
isTimeSeries :: Maybe Bool
A Boolean value that specifies whether the property consists of time series data.

Instances

Instances details

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

newPropertyDefinitionRequest :: PropertyDefinitionRequest Source #

Create a value of PropertyDefinitionRequest 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:PropertyDefinitionRequest', propertyDefinitionRequest_configuration - A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

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

$sel:defaultValue:PropertyDefinitionRequest', propertyDefinitionRequest_defaultValue - An object that contains the default value.

$sel:displayName:PropertyDefinitionRequest', propertyDefinitionRequest_displayName - A friendly name for the property.

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

$sel:isRequiredInEntity:PropertyDefinitionRequest', propertyDefinitionRequest_isRequiredInEntity - A Boolean value that specifies whether the property is required.

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

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

propertyDefinitionRequest_configuration :: Lens' PropertyDefinitionRequest (Maybe (HashMap Text Text)) Source #

A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

propertyDefinitionRequest_dataType :: Lens' PropertyDefinitionRequest (Maybe DataType) Source #

An object that contains information about the data type.

propertyDefinitionRequest_defaultValue :: Lens' PropertyDefinitionRequest (Maybe DataValue) Source #

An object that contains the default value.

propertyDefinitionRequest_displayName :: Lens' PropertyDefinitionRequest (Maybe Text) Source #

A friendly name for the property.

propertyDefinitionRequest_isExternalId :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

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

propertyDefinitionRequest_isRequiredInEntity :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

A Boolean value that specifies whether the property is required.

propertyDefinitionRequest_isStoredExternally :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

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

propertyDefinitionRequest_isTimeSeries :: Lens' PropertyDefinitionRequest (Maybe Bool) Source #

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