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.IoT.Types.MqttHeaders

Description

Documentation

data MqttHeaders Source #

Specifies MQTT Version 5.0 headers information. For more information, see MQTT from Amazon Web Services IoT Core Developer Guide.

See: newMqttHeaders smart constructor.

Constructors

MqttHeaders'

Fields

contentType :: Maybe Text
A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
correlationData :: Maybe Text
The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
messageExpiry :: Maybe Text
A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
Supports substitution templates.
payloadFormatIndicator :: Maybe Text
An Enum string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES and UTF8_DATA.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
responseTopic :: Maybe Text
A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
userProperties :: Maybe (NonEmpty UserProperty)
An array of key-value pairs that you define in the MQTT5 header.

Instances

Instances details

FromJSON MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Methods parseJSON :: Value -> Parser MqttHeaders # parseJSONList :: Value -> Parser [MqttHeaders] #
ToJSON MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Methods toJSON :: MqttHeaders -> Value # toEncoding :: MqttHeaders -> Encoding # toJSONList :: [MqttHeaders] -> Value # toEncodingList :: [MqttHeaders] -> Encoding #
Generic MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Associated Types type Rep MqttHeaders :: Type -> Type # Methods from :: MqttHeaders -> Rep MqttHeaders x # to :: Rep MqttHeaders x -> MqttHeaders #
Read MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Methods readsPrec :: Int -> ReadS MqttHeaders # readList :: ReadS [MqttHeaders] # readPrec :: ReadPrec MqttHeaders # readListPrec :: ReadPrec [MqttHeaders] #
Show MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Methods showsPrec :: Int -> MqttHeaders -> ShowS # show :: MqttHeaders -> String # showList :: [MqttHeaders] -> ShowS #
NFData MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Methods rnf :: MqttHeaders -> () #
Eq MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Methods (==) :: MqttHeaders -> MqttHeaders -> Bool # (/=) :: MqttHeaders -> MqttHeaders -> Bool #
Hashable MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders Methods hashWithSalt :: Int -> MqttHeaders -> Int # hash :: MqttHeaders -> Int #
type Rep MqttHeaders Source #
Instance details Defined in Amazonka.IoT.Types.MqttHeaders type Rep MqttHeaders = D1 ('MetaData "MqttHeaders" "Amazonka.IoT.Types.MqttHeaders" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "MqttHeaders'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "correlationData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "messageExpiry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "payloadFormatIndicator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "responseTopic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty UserProperty)))))))

newMqttHeaders :: MqttHeaders Source #

Create a value of MqttHeaders 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:contentType:MqttHeaders', mqttHeaders_contentType - A UTF-8 encoded string that describes the content of the publishing message.

For more information, see Content Type from the MQTT Version 5.0 specification.

Supports substitution templates.

$sel:correlationData:MqttHeaders', mqttHeaders_correlationData - The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.

For more information, see Correlation Data from the MQTT Version 5.0 specification.

This binary data must be based64-encoded.

Supports substitution templates.

$sel:messageExpiry:MqttHeaders', mqttHeaders_messageExpiry - A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

Supports substitution templates.

$sel:payloadFormatIndicator:MqttHeaders', mqttHeaders_payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA.

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates.

$sel:responseTopic:MqttHeaders', mqttHeaders_responseTopic - A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

For more information, see Response Topic from the MQTT Version 5.0 specification.

Supports substitution templates.

$sel:userProperties:MqttHeaders', mqttHeaders_userProperties - An array of key-value pairs that you define in the MQTT5 header.

mqttHeaders_contentType :: Lens' MqttHeaders (Maybe Text) Source #

A UTF-8 encoded string that describes the content of the publishing message.

For more information, see Content Type from the MQTT Version 5.0 specification.

Supports substitution templates.

mqttHeaders_correlationData :: Lens' MqttHeaders (Maybe Text) Source #

The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.

For more information, see Correlation Data from the MQTT Version 5.0 specification.

This binary data must be based64-encoded.

Supports substitution templates.

mqttHeaders_messageExpiry :: Lens' MqttHeaders (Maybe Text) Source #

A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

Supports substitution templates.

mqttHeaders_payloadFormatIndicator :: Lens' MqttHeaders (Maybe Text) Source #

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA.

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates.

mqttHeaders_responseTopic :: Lens' MqttHeaders (Maybe Text) Source #

A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

For more information, see Response Topic from the MQTT Version 5.0 specification.

Supports substitution templates.

mqttHeaders_userProperties :: Lens' MqttHeaders (Maybe (NonEmpty UserProperty)) Source #

An array of key-value pairs that you define in the MQTT5 header.