{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SQS.Types.MessageAttributeValue
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.SQS.Types.MessageAttributeValue where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | The user-specified message attribute value. For string data types, the
-- @Value@ attribute has the same restrictions on the content as the
-- message body. For more information, see @ @@SendMessage@@.@
--
-- @Name@, @type@, @value@ and the message body must not be empty or null.
-- All parts of the message attribute, including @Name@, @Type@, and
-- @Value@, are part of the message size restriction (256 KB or 262,144
-- bytes).
--
-- /See:/ 'newMessageAttributeValue' smart constructor.
data MessageAttributeValue = MessageAttributeValue'
  { -- | Not implemented. Reserved for future use.
    MessageAttributeValue -> Maybe [Base64]
binaryListValues :: Prelude.Maybe [Data.Base64],
    -- | Binary type attributes can store any binary data, such as compressed
    -- data, encrypted data, or images.
    MessageAttributeValue -> Maybe Base64
binaryValue :: Prelude.Maybe Data.Base64,
    -- | Not implemented. Reserved for future use.
    MessageAttributeValue -> Maybe [Text]
stringListValues :: Prelude.Maybe [Prelude.Text],
    -- | Strings are Unicode with UTF-8 binary encoding. For a list of code
    -- values, see
    -- <http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters ASCII Printable Characters>.
    MessageAttributeValue -> Maybe Text
stringValue :: Prelude.Maybe Prelude.Text,
    -- | Amazon SQS supports the following logical data types: @String@,
    -- @Number@, and @Binary@. For the @Number@ data type, you must use
    -- @StringValue@.
    --
    -- You can also append custom labels. For more information, see
    -- <https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes Amazon SQS Message Attributes>
    -- in the /Amazon SQS Developer Guide/.
    MessageAttributeValue -> Text
dataType :: Prelude.Text
  }
  deriving (MessageAttributeValue -> MessageAttributeValue -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MessageAttributeValue -> MessageAttributeValue -> Bool
$c/= :: MessageAttributeValue -> MessageAttributeValue -> Bool
== :: MessageAttributeValue -> MessageAttributeValue -> Bool
$c== :: MessageAttributeValue -> MessageAttributeValue -> Bool
Prelude.Eq, ReadPrec [MessageAttributeValue]
ReadPrec MessageAttributeValue
Int -> ReadS MessageAttributeValue
ReadS [MessageAttributeValue]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MessageAttributeValue]
$creadListPrec :: ReadPrec [MessageAttributeValue]
readPrec :: ReadPrec MessageAttributeValue
$creadPrec :: ReadPrec MessageAttributeValue
readList :: ReadS [MessageAttributeValue]
$creadList :: ReadS [MessageAttributeValue]
readsPrec :: Int -> ReadS MessageAttributeValue
$creadsPrec :: Int -> ReadS MessageAttributeValue
Prelude.Read, Int -> MessageAttributeValue -> ShowS
[MessageAttributeValue] -> ShowS
MessageAttributeValue -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MessageAttributeValue] -> ShowS
$cshowList :: [MessageAttributeValue] -> ShowS
show :: MessageAttributeValue -> String
$cshow :: MessageAttributeValue -> String
showsPrec :: Int -> MessageAttributeValue -> ShowS
$cshowsPrec :: Int -> MessageAttributeValue -> ShowS
Prelude.Show, forall x. Rep MessageAttributeValue x -> MessageAttributeValue
forall x. MessageAttributeValue -> Rep MessageAttributeValue x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MessageAttributeValue x -> MessageAttributeValue
$cfrom :: forall x. MessageAttributeValue -> Rep MessageAttributeValue x
Prelude.Generic)

-- |
-- Create a value of 'MessageAttributeValue' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'binaryListValues', 'messageAttributeValue_binaryListValues' - Not implemented. Reserved for future use.
--
-- 'binaryValue', 'messageAttributeValue_binaryValue' - Binary type attributes can store any binary data, such as compressed
-- data, encrypted data, or images.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
--
-- 'stringListValues', 'messageAttributeValue_stringListValues' - Not implemented. Reserved for future use.
--
-- 'stringValue', 'messageAttributeValue_stringValue' - Strings are Unicode with UTF-8 binary encoding. For a list of code
-- values, see
-- <http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters ASCII Printable Characters>.
--
-- 'dataType', 'messageAttributeValue_dataType' - Amazon SQS supports the following logical data types: @String@,
-- @Number@, and @Binary@. For the @Number@ data type, you must use
-- @StringValue@.
--
-- You can also append custom labels. For more information, see
-- <https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes Amazon SQS Message Attributes>
-- in the /Amazon SQS Developer Guide/.
newMessageAttributeValue ::
  -- | 'dataType'
  Prelude.Text ->
  MessageAttributeValue
newMessageAttributeValue :: Text -> MessageAttributeValue
newMessageAttributeValue Text
pDataType_ =
  MessageAttributeValue'
    { $sel:binaryListValues:MessageAttributeValue' :: Maybe [Base64]
binaryListValues =
        forall a. Maybe a
Prelude.Nothing,
      $sel:binaryValue:MessageAttributeValue' :: Maybe Base64
binaryValue = forall a. Maybe a
Prelude.Nothing,
      $sel:stringListValues:MessageAttributeValue' :: Maybe [Text]
stringListValues = forall a. Maybe a
Prelude.Nothing,
      $sel:stringValue:MessageAttributeValue' :: Maybe Text
stringValue = forall a. Maybe a
Prelude.Nothing,
      $sel:dataType:MessageAttributeValue' :: Text
dataType = Text
pDataType_
    }

-- | Not implemented. Reserved for future use.
messageAttributeValue_binaryListValues :: Lens.Lens' MessageAttributeValue (Prelude.Maybe [Prelude.ByteString])
messageAttributeValue_binaryListValues :: Lens' MessageAttributeValue (Maybe [ByteString])
messageAttributeValue_binaryListValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MessageAttributeValue' {Maybe [Base64]
binaryListValues :: Maybe [Base64]
$sel:binaryListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Base64]
binaryListValues} -> Maybe [Base64]
binaryListValues) (\s :: MessageAttributeValue
s@MessageAttributeValue' {} Maybe [Base64]
a -> MessageAttributeValue
s {$sel:binaryListValues:MessageAttributeValue' :: Maybe [Base64]
binaryListValues = Maybe [Base64]
a} :: MessageAttributeValue) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Binary type attributes can store any binary data, such as compressed
-- data, encrypted data, or images.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
messageAttributeValue_binaryValue :: Lens.Lens' MessageAttributeValue (Prelude.Maybe Prelude.ByteString)
messageAttributeValue_binaryValue :: Lens' MessageAttributeValue (Maybe ByteString)
messageAttributeValue_binaryValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MessageAttributeValue' {Maybe Base64
binaryValue :: Maybe Base64
$sel:binaryValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Base64
binaryValue} -> Maybe Base64
binaryValue) (\s :: MessageAttributeValue
s@MessageAttributeValue' {} Maybe Base64
a -> MessageAttributeValue
s {$sel:binaryValue:MessageAttributeValue' :: Maybe Base64
binaryValue = Maybe Base64
a} :: MessageAttributeValue) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping Iso' Base64 ByteString
Data._Base64

-- | Not implemented. Reserved for future use.
messageAttributeValue_stringListValues :: Lens.Lens' MessageAttributeValue (Prelude.Maybe [Prelude.Text])
messageAttributeValue_stringListValues :: Lens' MessageAttributeValue (Maybe [Text])
messageAttributeValue_stringListValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MessageAttributeValue' {Maybe [Text]
stringListValues :: Maybe [Text]
$sel:stringListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Text]
stringListValues} -> Maybe [Text]
stringListValues) (\s :: MessageAttributeValue
s@MessageAttributeValue' {} Maybe [Text]
a -> MessageAttributeValue
s {$sel:stringListValues:MessageAttributeValue' :: Maybe [Text]
stringListValues = Maybe [Text]
a} :: MessageAttributeValue) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Strings are Unicode with UTF-8 binary encoding. For a list of code
-- values, see
-- <http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters ASCII Printable Characters>.
messageAttributeValue_stringValue :: Lens.Lens' MessageAttributeValue (Prelude.Maybe Prelude.Text)
messageAttributeValue_stringValue :: Lens' MessageAttributeValue (Maybe Text)
messageAttributeValue_stringValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MessageAttributeValue' {Maybe Text
stringValue :: Maybe Text
$sel:stringValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Text
stringValue} -> Maybe Text
stringValue) (\s :: MessageAttributeValue
s@MessageAttributeValue' {} Maybe Text
a -> MessageAttributeValue
s {$sel:stringValue:MessageAttributeValue' :: Maybe Text
stringValue = Maybe Text
a} :: MessageAttributeValue)

-- | Amazon SQS supports the following logical data types: @String@,
-- @Number@, and @Binary@. For the @Number@ data type, you must use
-- @StringValue@.
--
-- You can also append custom labels. For more information, see
-- <https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes Amazon SQS Message Attributes>
-- in the /Amazon SQS Developer Guide/.
messageAttributeValue_dataType :: Lens.Lens' MessageAttributeValue Prelude.Text
messageAttributeValue_dataType :: Lens' MessageAttributeValue Text
messageAttributeValue_dataType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MessageAttributeValue' {Text
dataType :: Text
$sel:dataType:MessageAttributeValue' :: MessageAttributeValue -> Text
dataType} -> Text
dataType) (\s :: MessageAttributeValue
s@MessageAttributeValue' {} Text
a -> MessageAttributeValue
s {$sel:dataType:MessageAttributeValue' :: Text
dataType = Text
a} :: MessageAttributeValue)

instance Data.FromXML MessageAttributeValue where
  parseXML :: [Node] -> Either String MessageAttributeValue
parseXML [Node]
x =
    Maybe [Base64]
-> Maybe Base64
-> Maybe [Text]
-> Maybe Text
-> Text
-> MessageAttributeValue
MessageAttributeValue'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"BinaryListValue"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"BinaryListValue")
                  )
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"BinaryValue")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"StringListValue"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"StringListValue")
                  )
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"StringValue")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"DataType")

instance Prelude.Hashable MessageAttributeValue where
  hashWithSalt :: Int -> MessageAttributeValue -> Int
hashWithSalt Int
_salt MessageAttributeValue' {Maybe [Text]
Maybe [Base64]
Maybe Text
Maybe Base64
Text
dataType :: Text
stringValue :: Maybe Text
stringListValues :: Maybe [Text]
binaryValue :: Maybe Base64
binaryListValues :: Maybe [Base64]
$sel:dataType:MessageAttributeValue' :: MessageAttributeValue -> Text
$sel:stringValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Text
$sel:stringListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Text]
$sel:binaryValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Base64
$sel:binaryListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Base64]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Base64]
binaryListValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Base64
binaryValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
stringListValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
stringValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
dataType

instance Prelude.NFData MessageAttributeValue where
  rnf :: MessageAttributeValue -> ()
rnf MessageAttributeValue' {Maybe [Text]
Maybe [Base64]
Maybe Text
Maybe Base64
Text
dataType :: Text
stringValue :: Maybe Text
stringListValues :: Maybe [Text]
binaryValue :: Maybe Base64
binaryListValues :: Maybe [Base64]
$sel:dataType:MessageAttributeValue' :: MessageAttributeValue -> Text
$sel:stringValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Text
$sel:stringListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Text]
$sel:binaryValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Base64
$sel:binaryListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Base64]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Base64]
binaryListValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Base64
binaryValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
stringListValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
stringValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
dataType

instance Data.ToQuery MessageAttributeValue where
  toQuery :: MessageAttributeValue -> QueryString
toQuery MessageAttributeValue' {Maybe [Text]
Maybe [Base64]
Maybe Text
Maybe Base64
Text
dataType :: Text
stringValue :: Maybe Text
stringListValues :: Maybe [Text]
binaryValue :: Maybe Base64
binaryListValues :: Maybe [Base64]
$sel:dataType:MessageAttributeValue' :: MessageAttributeValue -> Text
$sel:stringValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Text
$sel:stringListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Text]
$sel:binaryValue:MessageAttributeValue' :: MessageAttributeValue -> Maybe Base64
$sel:binaryListValues:MessageAttributeValue' :: MessageAttributeValue -> Maybe [Base64]
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"BinaryListValue"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            ( forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"BinaryListValue"
                forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Base64]
binaryListValues
            ),
        ByteString
"BinaryValue" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Base64
binaryValue,
        ByteString
"StringListValue"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            ( forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"StringListValue"
                forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
stringListValues
            ),
        ByteString
"StringValue" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
stringValue,
        ByteString
"DataType" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
dataType
      ]