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.IoTFleetWise.Types.NetworkInterface

Description

Documentation

data NetworkInterface Source #

Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.

To return this information about all the network interfaces specified in a decoder manifest, use the API operation.

See: newNetworkInterface smart constructor.

Constructors

NetworkInterface'

Fields

canInterface :: Maybe CanInterface
Information about a network interface specified by the Controller Area Network (CAN) protocol.
obdInterface :: Maybe ObdInterface
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
interfaceId :: Text
The ID of the network interface.
type' :: NetworkInterfaceType
The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

Instances

Instances details

FromJSON NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Methods parseJSON :: Value -> Parser NetworkInterface # parseJSONList :: Value -> Parser [NetworkInterface] #
ToJSON NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Methods toJSON :: NetworkInterface -> Value # toEncoding :: NetworkInterface -> Encoding # toJSONList :: [NetworkInterface] -> Value # toEncodingList :: [NetworkInterface] -> Encoding #
Generic NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Associated Types type Rep NetworkInterface :: Type -> Type # Methods from :: NetworkInterface -> Rep NetworkInterface x # to :: Rep NetworkInterface x -> NetworkInterface #
Read NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Methods readsPrec :: Int -> ReadS NetworkInterface # readList :: ReadS [NetworkInterface] # readPrec :: ReadPrec NetworkInterface # readListPrec :: ReadPrec [NetworkInterface] #
Show NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Methods showsPrec :: Int -> NetworkInterface -> ShowS # show :: NetworkInterface -> String # showList :: [NetworkInterface] -> ShowS #
NFData NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Methods rnf :: NetworkInterface -> () #
Eq NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Methods (==) :: NetworkInterface -> NetworkInterface -> Bool # (/=) :: NetworkInterface -> NetworkInterface -> Bool #
Hashable NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface Methods hashWithSalt :: Int -> NetworkInterface -> Int # hash :: NetworkInterface -> Int #
type Rep NetworkInterface Source #
Instance details Defined in Amazonka.IoTFleetWise.Types.NetworkInterface type Rep NetworkInterface = D1 ('MetaData "NetworkInterface" "Amazonka.IoTFleetWise.Types.NetworkInterface" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "NetworkInterface'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "canInterface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanInterface)) :: S1 ('MetaSel ('Just "obdInterface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObdInterface))) :: (S1 ('MetaSel ('Just "interfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NetworkInterfaceType))))

newNetworkInterface Source #

Arguments

:: Text	`$sel:interfaceId:NetworkInterface'`
-> NetworkInterfaceType	`$sel:type':NetworkInterface'`
-> NetworkInterface

Create a value of NetworkInterface 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:canInterface:NetworkInterface', networkInterface_canInterface - Information about a network interface specified by the Controller Area Network (CAN) protocol.

$sel:obdInterface:NetworkInterface', networkInterface_obdInterface - Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

$sel:interfaceId:NetworkInterface', networkInterface_interfaceId - The ID of the network interface.

$sel:type':NetworkInterface', networkInterface_type - The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

networkInterface_canInterface :: Lens' NetworkInterface (Maybe CanInterface) Source #

Information about a network interface specified by the Controller Area Network (CAN) protocol.

networkInterface_obdInterface :: Lens' NetworkInterface (Maybe ObdInterface) Source #

Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

networkInterface_interfaceId :: Lens' NetworkInterface Text Source #

The ID of the network interface.

networkInterface_type :: Lens' NetworkInterface NetworkInterfaceType Source #

The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.