ChangeProgressStatusDetails.hs

{-# 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.OpenSearch.Types.ChangeProgressStatusDetails
-- 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.OpenSearch.Types.ChangeProgressStatusDetails where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.OpenSearch.Types.ChangeProgressStage
import Amazonka.OpenSearch.Types.OverallChangeStatus
import qualified Amazonka.Prelude as Prelude

-- | The progress details of a specific domain configuration change.
--
-- /See:/ 'newChangeProgressStatusDetails' smart constructor.
data ChangeProgressStatusDetails = ChangeProgressStatusDetails'
  { -- | The unique change identifier associated with a specific domain
    -- configuration change.
    changeId :: Prelude.Maybe Prelude.Text,
    -- | The specific stages that the domain is going through to perform the
    -- configuration change.
    changeProgressStages :: Prelude.Maybe [ChangeProgressStage],
    -- | The list of properties in the domain configuration change that have
    -- completed.
    completedProperties :: Prelude.Maybe [Prelude.Text],
    -- | The list of properties in the domain configuration change that are still
    -- pending.
    pendingProperties :: Prelude.Maybe [Prelude.Text],
    -- | The time at which the configuration change is made on the domain.
    startTime :: Prelude.Maybe Data.POSIX,
    -- | The overall status of the domain configuration change.
    status :: Prelude.Maybe OverallChangeStatus,
    -- | The total number of stages required for the configuration change.
    totalNumberOfStages :: Prelude.Maybe Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ChangeProgressStatusDetails' 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:
--
-- 'changeId', 'changeProgressStatusDetails_changeId' - The unique change identifier associated with a specific domain
-- configuration change.
--
-- 'changeProgressStages', 'changeProgressStatusDetails_changeProgressStages' - The specific stages that the domain is going through to perform the
-- configuration change.
--
-- 'completedProperties', 'changeProgressStatusDetails_completedProperties' - The list of properties in the domain configuration change that have
-- completed.
--
-- 'pendingProperties', 'changeProgressStatusDetails_pendingProperties' - The list of properties in the domain configuration change that are still
-- pending.
--
-- 'startTime', 'changeProgressStatusDetails_startTime' - The time at which the configuration change is made on the domain.
--
-- 'status', 'changeProgressStatusDetails_status' - The overall status of the domain configuration change.
--
-- 'totalNumberOfStages', 'changeProgressStatusDetails_totalNumberOfStages' - The total number of stages required for the configuration change.
newChangeProgressStatusDetails ::
  ChangeProgressStatusDetails
newChangeProgressStatusDetails =
  ChangeProgressStatusDetails'
    { changeId =
        Prelude.Nothing,
      changeProgressStages = Prelude.Nothing,
      completedProperties = Prelude.Nothing,
      pendingProperties = Prelude.Nothing,
      startTime = Prelude.Nothing,
      status = Prelude.Nothing,
      totalNumberOfStages = Prelude.Nothing
    }

-- | The unique change identifier associated with a specific domain
-- configuration change.
changeProgressStatusDetails_changeId :: Lens.Lens' ChangeProgressStatusDetails (Prelude.Maybe Prelude.Text)
changeProgressStatusDetails_changeId = Lens.lens (\ChangeProgressStatusDetails' {changeId} -> changeId) (\s@ChangeProgressStatusDetails' {} a -> s {changeId = a} :: ChangeProgressStatusDetails)

-- | The specific stages that the domain is going through to perform the
-- configuration change.
changeProgressStatusDetails_changeProgressStages :: Lens.Lens' ChangeProgressStatusDetails (Prelude.Maybe [ChangeProgressStage])
changeProgressStatusDetails_changeProgressStages = Lens.lens (\ChangeProgressStatusDetails' {changeProgressStages} -> changeProgressStages) (\s@ChangeProgressStatusDetails' {} a -> s {changeProgressStages = a} :: ChangeProgressStatusDetails) Prelude.. Lens.mapping Lens.coerced

-- | The list of properties in the domain configuration change that have
-- completed.
changeProgressStatusDetails_completedProperties :: Lens.Lens' ChangeProgressStatusDetails (Prelude.Maybe [Prelude.Text])
changeProgressStatusDetails_completedProperties = Lens.lens (\ChangeProgressStatusDetails' {completedProperties} -> completedProperties) (\s@ChangeProgressStatusDetails' {} a -> s {completedProperties = a} :: ChangeProgressStatusDetails) Prelude.. Lens.mapping Lens.coerced

-- | The list of properties in the domain configuration change that are still
-- pending.
changeProgressStatusDetails_pendingProperties :: Lens.Lens' ChangeProgressStatusDetails (Prelude.Maybe [Prelude.Text])
changeProgressStatusDetails_pendingProperties = Lens.lens (\ChangeProgressStatusDetails' {pendingProperties} -> pendingProperties) (\s@ChangeProgressStatusDetails' {} a -> s {pendingProperties = a} :: ChangeProgressStatusDetails) Prelude.. Lens.mapping Lens.coerced

-- | The time at which the configuration change is made on the domain.
changeProgressStatusDetails_startTime :: Lens.Lens' ChangeProgressStatusDetails (Prelude.Maybe Prelude.UTCTime)
changeProgressStatusDetails_startTime = Lens.lens (\ChangeProgressStatusDetails' {startTime} -> startTime) (\s@ChangeProgressStatusDetails' {} a -> s {startTime = a} :: ChangeProgressStatusDetails) Prelude.. Lens.mapping Data._Time

-- | The overall status of the domain configuration change.
changeProgressStatusDetails_status :: Lens.Lens' ChangeProgressStatusDetails (Prelude.Maybe OverallChangeStatus)
changeProgressStatusDetails_status = Lens.lens (\ChangeProgressStatusDetails' {status} -> status) (\s@ChangeProgressStatusDetails' {} a -> s {status = a} :: ChangeProgressStatusDetails)

-- | The total number of stages required for the configuration change.
changeProgressStatusDetails_totalNumberOfStages :: Lens.Lens' ChangeProgressStatusDetails (Prelude.Maybe Prelude.Int)
changeProgressStatusDetails_totalNumberOfStages = Lens.lens (\ChangeProgressStatusDetails' {totalNumberOfStages} -> totalNumberOfStages) (\s@ChangeProgressStatusDetails' {} a -> s {totalNumberOfStages = a} :: ChangeProgressStatusDetails)

instance Data.FromJSON ChangeProgressStatusDetails where
  parseJSON =
    Data.withObject
      "ChangeProgressStatusDetails"
      ( \x ->
          ChangeProgressStatusDetails'
            Prelude.<$> (x Data..:? "ChangeId")
            Prelude.<*> ( x
                            Data..:? "ChangeProgressStages"
                            Data..!= Prelude.mempty
                        )
            Prelude.<*> ( x
                            Data..:? "CompletedProperties"
                            Data..!= Prelude.mempty
                        )
            Prelude.<*> ( x
                            Data..:? "PendingProperties"
                            Data..!= Prelude.mempty
                        )
            Prelude.<*> (x Data..:? "StartTime")
            Prelude.<*> (x Data..:? "Status")
            Prelude.<*> (x Data..:? "TotalNumberOfStages")
      )

instance Prelude.Hashable ChangeProgressStatusDetails where
  hashWithSalt _salt ChangeProgressStatusDetails' {..} =
    _salt
      `Prelude.hashWithSalt` changeId
      `Prelude.hashWithSalt` changeProgressStages
      `Prelude.hashWithSalt` completedProperties
      `Prelude.hashWithSalt` pendingProperties
      `Prelude.hashWithSalt` startTime
      `Prelude.hashWithSalt` status
      `Prelude.hashWithSalt` totalNumberOfStages

instance Prelude.NFData ChangeProgressStatusDetails where
  rnf ChangeProgressStatusDetails' {..} =
    Prelude.rnf changeId
      `Prelude.seq` Prelude.rnf changeProgressStages
      `Prelude.seq` Prelude.rnf completedProperties
      `Prelude.seq` Prelude.rnf pendingProperties
      `Prelude.seq` Prelude.rnf startTime
      `Prelude.seq` Prelude.rnf status
      `Prelude.seq` Prelude.rnf totalNumberOfStages