{-# 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.WorkDocs.Types.DocumentMetadata
-- 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.WorkDocs.Types.DocumentMetadata 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
import Amazonka.WorkDocs.Types.DocumentVersionMetadata
import Amazonka.WorkDocs.Types.ResourceStateType

-- | Describes the document.
--
-- /See:/ 'newDocumentMetadata' smart constructor.
data DocumentMetadata = DocumentMetadata'
  { -- | The time when the document was created.
    DocumentMetadata -> Maybe POSIX
createdTimestamp :: Prelude.Maybe Data.POSIX,
    -- | The ID of the creator.
    DocumentMetadata -> Maybe Text
creatorId :: Prelude.Maybe Prelude.Text,
    -- | The ID of the document.
    DocumentMetadata -> Maybe Text
id :: Prelude.Maybe Prelude.Text,
    -- | List of labels on the document.
    DocumentMetadata -> Maybe [Text]
labels :: Prelude.Maybe [Prelude.Text],
    -- | The latest version of the document.
    DocumentMetadata -> Maybe DocumentVersionMetadata
latestVersionMetadata :: Prelude.Maybe DocumentVersionMetadata,
    -- | The time when the document was updated.
    DocumentMetadata -> Maybe POSIX
modifiedTimestamp :: Prelude.Maybe Data.POSIX,
    -- | The ID of the parent folder.
    DocumentMetadata -> Maybe Text
parentFolderId :: Prelude.Maybe Prelude.Text,
    -- | The resource state.
    DocumentMetadata -> Maybe ResourceStateType
resourceState :: Prelude.Maybe ResourceStateType
  }
  deriving (DocumentMetadata -> DocumentMetadata -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DocumentMetadata -> DocumentMetadata -> Bool
$c/= :: DocumentMetadata -> DocumentMetadata -> Bool
== :: DocumentMetadata -> DocumentMetadata -> Bool
$c== :: DocumentMetadata -> DocumentMetadata -> Bool
Prelude.Eq, Int -> DocumentMetadata -> ShowS
[DocumentMetadata] -> ShowS
DocumentMetadata -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DocumentMetadata] -> ShowS
$cshowList :: [DocumentMetadata] -> ShowS
show :: DocumentMetadata -> String
$cshow :: DocumentMetadata -> String
showsPrec :: Int -> DocumentMetadata -> ShowS
$cshowsPrec :: Int -> DocumentMetadata -> ShowS
Prelude.Show, forall x. Rep DocumentMetadata x -> DocumentMetadata
forall x. DocumentMetadata -> Rep DocumentMetadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DocumentMetadata x -> DocumentMetadata
$cfrom :: forall x. DocumentMetadata -> Rep DocumentMetadata x
Prelude.Generic)

-- |
-- Create a value of 'DocumentMetadata' 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:
--
-- 'createdTimestamp', 'documentMetadata_createdTimestamp' - The time when the document was created.
--
-- 'creatorId', 'documentMetadata_creatorId' - The ID of the creator.
--
-- 'id', 'documentMetadata_id' - The ID of the document.
--
-- 'labels', 'documentMetadata_labels' - List of labels on the document.
--
-- 'latestVersionMetadata', 'documentMetadata_latestVersionMetadata' - The latest version of the document.
--
-- 'modifiedTimestamp', 'documentMetadata_modifiedTimestamp' - The time when the document was updated.
--
-- 'parentFolderId', 'documentMetadata_parentFolderId' - The ID of the parent folder.
--
-- 'resourceState', 'documentMetadata_resourceState' - The resource state.
newDocumentMetadata ::
  DocumentMetadata
newDocumentMetadata :: DocumentMetadata
newDocumentMetadata =
  DocumentMetadata'
    { $sel:createdTimestamp:DocumentMetadata' :: Maybe POSIX
createdTimestamp =
        forall a. Maybe a
Prelude.Nothing,
      $sel:creatorId:DocumentMetadata' :: Maybe Text
creatorId = forall a. Maybe a
Prelude.Nothing,
      $sel:id:DocumentMetadata' :: Maybe Text
id = forall a. Maybe a
Prelude.Nothing,
      $sel:labels:DocumentMetadata' :: Maybe [Text]
labels = forall a. Maybe a
Prelude.Nothing,
      $sel:latestVersionMetadata:DocumentMetadata' :: Maybe DocumentVersionMetadata
latestVersionMetadata = forall a. Maybe a
Prelude.Nothing,
      $sel:modifiedTimestamp:DocumentMetadata' :: Maybe POSIX
modifiedTimestamp = forall a. Maybe a
Prelude.Nothing,
      $sel:parentFolderId:DocumentMetadata' :: Maybe Text
parentFolderId = forall a. Maybe a
Prelude.Nothing,
      $sel:resourceState:DocumentMetadata' :: Maybe ResourceStateType
resourceState = forall a. Maybe a
Prelude.Nothing
    }

-- | The time when the document was created.
documentMetadata_createdTimestamp :: Lens.Lens' DocumentMetadata (Prelude.Maybe Prelude.UTCTime)
documentMetadata_createdTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
documentMetadata_createdTimestamp = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe POSIX
createdTimestamp :: Maybe POSIX
$sel:createdTimestamp:DocumentMetadata' :: DocumentMetadata -> Maybe POSIX
createdTimestamp} -> Maybe POSIX
createdTimestamp) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe POSIX
a -> DocumentMetadata
s {$sel:createdTimestamp:DocumentMetadata' :: Maybe POSIX
createdTimestamp = Maybe POSIX
a} :: DocumentMetadata) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The ID of the creator.
documentMetadata_creatorId :: Lens.Lens' DocumentMetadata (Prelude.Maybe Prelude.Text)
documentMetadata_creatorId :: Lens' DocumentMetadata (Maybe Text)
documentMetadata_creatorId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe Text
creatorId :: Maybe Text
$sel:creatorId:DocumentMetadata' :: DocumentMetadata -> Maybe Text
creatorId} -> Maybe Text
creatorId) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe Text
a -> DocumentMetadata
s {$sel:creatorId:DocumentMetadata' :: Maybe Text
creatorId = Maybe Text
a} :: DocumentMetadata)

-- | The ID of the document.
documentMetadata_id :: Lens.Lens' DocumentMetadata (Prelude.Maybe Prelude.Text)
documentMetadata_id :: Lens' DocumentMetadata (Maybe Text)
documentMetadata_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe Text
id :: Maybe Text
$sel:id:DocumentMetadata' :: DocumentMetadata -> Maybe Text
id} -> Maybe Text
id) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe Text
a -> DocumentMetadata
s {$sel:id:DocumentMetadata' :: Maybe Text
id = Maybe Text
a} :: DocumentMetadata)

-- | List of labels on the document.
documentMetadata_labels :: Lens.Lens' DocumentMetadata (Prelude.Maybe [Prelude.Text])
documentMetadata_labels :: Lens' DocumentMetadata (Maybe [Text])
documentMetadata_labels = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe [Text]
labels :: Maybe [Text]
$sel:labels:DocumentMetadata' :: DocumentMetadata -> Maybe [Text]
labels} -> Maybe [Text]
labels) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe [Text]
a -> DocumentMetadata
s {$sel:labels:DocumentMetadata' :: Maybe [Text]
labels = Maybe [Text]
a} :: DocumentMetadata) 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

-- | The latest version of the document.
documentMetadata_latestVersionMetadata :: Lens.Lens' DocumentMetadata (Prelude.Maybe DocumentVersionMetadata)
documentMetadata_latestVersionMetadata :: Lens' DocumentMetadata (Maybe DocumentVersionMetadata)
documentMetadata_latestVersionMetadata = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe DocumentVersionMetadata
latestVersionMetadata :: Maybe DocumentVersionMetadata
$sel:latestVersionMetadata:DocumentMetadata' :: DocumentMetadata -> Maybe DocumentVersionMetadata
latestVersionMetadata} -> Maybe DocumentVersionMetadata
latestVersionMetadata) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe DocumentVersionMetadata
a -> DocumentMetadata
s {$sel:latestVersionMetadata:DocumentMetadata' :: Maybe DocumentVersionMetadata
latestVersionMetadata = Maybe DocumentVersionMetadata
a} :: DocumentMetadata)

-- | The time when the document was updated.
documentMetadata_modifiedTimestamp :: Lens.Lens' DocumentMetadata (Prelude.Maybe Prelude.UTCTime)
documentMetadata_modifiedTimestamp :: Lens' DocumentMetadata (Maybe UTCTime)
documentMetadata_modifiedTimestamp = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe POSIX
modifiedTimestamp :: Maybe POSIX
$sel:modifiedTimestamp:DocumentMetadata' :: DocumentMetadata -> Maybe POSIX
modifiedTimestamp} -> Maybe POSIX
modifiedTimestamp) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe POSIX
a -> DocumentMetadata
s {$sel:modifiedTimestamp:DocumentMetadata' :: Maybe POSIX
modifiedTimestamp = Maybe POSIX
a} :: DocumentMetadata) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The ID of the parent folder.
documentMetadata_parentFolderId :: Lens.Lens' DocumentMetadata (Prelude.Maybe Prelude.Text)
documentMetadata_parentFolderId :: Lens' DocumentMetadata (Maybe Text)
documentMetadata_parentFolderId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe Text
parentFolderId :: Maybe Text
$sel:parentFolderId:DocumentMetadata' :: DocumentMetadata -> Maybe Text
parentFolderId} -> Maybe Text
parentFolderId) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe Text
a -> DocumentMetadata
s {$sel:parentFolderId:DocumentMetadata' :: Maybe Text
parentFolderId = Maybe Text
a} :: DocumentMetadata)

-- | The resource state.
documentMetadata_resourceState :: Lens.Lens' DocumentMetadata (Prelude.Maybe ResourceStateType)
documentMetadata_resourceState :: Lens' DocumentMetadata (Maybe ResourceStateType)
documentMetadata_resourceState = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadata' {Maybe ResourceStateType
resourceState :: Maybe ResourceStateType
$sel:resourceState:DocumentMetadata' :: DocumentMetadata -> Maybe ResourceStateType
resourceState} -> Maybe ResourceStateType
resourceState) (\s :: DocumentMetadata
s@DocumentMetadata' {} Maybe ResourceStateType
a -> DocumentMetadata
s {$sel:resourceState:DocumentMetadata' :: Maybe ResourceStateType
resourceState = Maybe ResourceStateType
a} :: DocumentMetadata)

instance Data.FromJSON DocumentMetadata where
  parseJSON :: Value -> Parser DocumentMetadata
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DocumentMetadata"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe [Text]
-> Maybe DocumentVersionMetadata
-> Maybe POSIX
-> Maybe Text
-> Maybe ResourceStateType
-> DocumentMetadata
DocumentMetadata'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CreatedTimestamp")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CreatorId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Id")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Labels" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"LatestVersionMetadata")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ModifiedTimestamp")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ParentFolderId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ResourceState")
      )

instance Prelude.Hashable DocumentMetadata where
  hashWithSalt :: Int -> DocumentMetadata -> Int
hashWithSalt Int
_salt DocumentMetadata' {Maybe [Text]
Maybe Text
Maybe POSIX
Maybe DocumentVersionMetadata
Maybe ResourceStateType
resourceState :: Maybe ResourceStateType
parentFolderId :: Maybe Text
modifiedTimestamp :: Maybe POSIX
latestVersionMetadata :: Maybe DocumentVersionMetadata
labels :: Maybe [Text]
id :: Maybe Text
creatorId :: Maybe Text
createdTimestamp :: Maybe POSIX
$sel:resourceState:DocumentMetadata' :: DocumentMetadata -> Maybe ResourceStateType
$sel:parentFolderId:DocumentMetadata' :: DocumentMetadata -> Maybe Text
$sel:modifiedTimestamp:DocumentMetadata' :: DocumentMetadata -> Maybe POSIX
$sel:latestVersionMetadata:DocumentMetadata' :: DocumentMetadata -> Maybe DocumentVersionMetadata
$sel:labels:DocumentMetadata' :: DocumentMetadata -> Maybe [Text]
$sel:id:DocumentMetadata' :: DocumentMetadata -> Maybe Text
$sel:creatorId:DocumentMetadata' :: DocumentMetadata -> Maybe Text
$sel:createdTimestamp:DocumentMetadata' :: DocumentMetadata -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
createdTimestamp
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
creatorId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
labels
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DocumentVersionMetadata
latestVersionMetadata
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
modifiedTimestamp
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
parentFolderId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ResourceStateType
resourceState

instance Prelude.NFData DocumentMetadata where
  rnf :: DocumentMetadata -> ()
rnf DocumentMetadata' {Maybe [Text]
Maybe Text
Maybe POSIX
Maybe DocumentVersionMetadata
Maybe ResourceStateType
resourceState :: Maybe ResourceStateType
parentFolderId :: Maybe Text
modifiedTimestamp :: Maybe POSIX
latestVersionMetadata :: Maybe DocumentVersionMetadata
labels :: Maybe [Text]
id :: Maybe Text
creatorId :: Maybe Text
createdTimestamp :: Maybe POSIX
$sel:resourceState:DocumentMetadata' :: DocumentMetadata -> Maybe ResourceStateType
$sel:parentFolderId:DocumentMetadata' :: DocumentMetadata -> Maybe Text
$sel:modifiedTimestamp:DocumentMetadata' :: DocumentMetadata -> Maybe POSIX
$sel:latestVersionMetadata:DocumentMetadata' :: DocumentMetadata -> Maybe DocumentVersionMetadata
$sel:labels:DocumentMetadata' :: DocumentMetadata -> Maybe [Text]
$sel:id:DocumentMetadata' :: DocumentMetadata -> Maybe Text
$sel:creatorId:DocumentMetadata' :: DocumentMetadata -> Maybe Text
$sel:createdTimestamp:DocumentMetadata' :: DocumentMetadata -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
createdTimestamp
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
creatorId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
id
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
labels
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DocumentVersionMetadata
latestVersionMetadata
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
modifiedTimestamp
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
parentFolderId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ResourceStateType
resourceState