{-# 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.SageMaker.Types.EndpointMetadata
-- 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.SageMaker.Types.EndpointMetadata 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.SageMaker.Types.EndpointStatus

-- | The metadata of the endpoint.
--
-- /See:/ 'newEndpointMetadata' smart constructor.
data EndpointMetadata = EndpointMetadata'
  { -- | The name of the endpoint configuration.
    EndpointMetadata -> Maybe Text
endpointConfigName :: Prelude.Maybe Prelude.Text,
    -- | The status of the endpoint. For possible values of the status of an
    -- endpoint, see EndpointSummary$EndpointStatus.
    EndpointMetadata -> Maybe EndpointStatus
endpointStatus :: Prelude.Maybe EndpointStatus,
    -- | If the status of the endpoint is @Failed@, or the status is @InService@
    -- but update operation fails, this provides the reason why it failed.
    EndpointMetadata -> Maybe Text
failureReason :: Prelude.Maybe Prelude.Text,
    -- | The name of the endpoint.
    EndpointMetadata -> Text
endpointName :: Prelude.Text
  }
  deriving (EndpointMetadata -> EndpointMetadata -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EndpointMetadata -> EndpointMetadata -> Bool
$c/= :: EndpointMetadata -> EndpointMetadata -> Bool
== :: EndpointMetadata -> EndpointMetadata -> Bool
$c== :: EndpointMetadata -> EndpointMetadata -> Bool
Prelude.Eq, ReadPrec [EndpointMetadata]
ReadPrec EndpointMetadata
Int -> ReadS EndpointMetadata
ReadS [EndpointMetadata]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EndpointMetadata]
$creadListPrec :: ReadPrec [EndpointMetadata]
readPrec :: ReadPrec EndpointMetadata
$creadPrec :: ReadPrec EndpointMetadata
readList :: ReadS [EndpointMetadata]
$creadList :: ReadS [EndpointMetadata]
readsPrec :: Int -> ReadS EndpointMetadata
$creadsPrec :: Int -> ReadS EndpointMetadata
Prelude.Read, Int -> EndpointMetadata -> ShowS
[EndpointMetadata] -> ShowS
EndpointMetadata -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EndpointMetadata] -> ShowS
$cshowList :: [EndpointMetadata] -> ShowS
show :: EndpointMetadata -> String
$cshow :: EndpointMetadata -> String
showsPrec :: Int -> EndpointMetadata -> ShowS
$cshowsPrec :: Int -> EndpointMetadata -> ShowS
Prelude.Show, forall x. Rep EndpointMetadata x -> EndpointMetadata
forall x. EndpointMetadata -> Rep EndpointMetadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EndpointMetadata x -> EndpointMetadata
$cfrom :: forall x. EndpointMetadata -> Rep EndpointMetadata x
Prelude.Generic)

-- |
-- Create a value of 'EndpointMetadata' 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:
--
-- 'endpointConfigName', 'endpointMetadata_endpointConfigName' - The name of the endpoint configuration.
--
-- 'endpointStatus', 'endpointMetadata_endpointStatus' - The status of the endpoint. For possible values of the status of an
-- endpoint, see EndpointSummary$EndpointStatus.
--
-- 'failureReason', 'endpointMetadata_failureReason' - If the status of the endpoint is @Failed@, or the status is @InService@
-- but update operation fails, this provides the reason why it failed.
--
-- 'endpointName', 'endpointMetadata_endpointName' - The name of the endpoint.
newEndpointMetadata ::
  -- | 'endpointName'
  Prelude.Text ->
  EndpointMetadata
newEndpointMetadata :: Text -> EndpointMetadata
newEndpointMetadata Text
pEndpointName_ =
  EndpointMetadata'
    { $sel:endpointConfigName:EndpointMetadata' :: Maybe Text
endpointConfigName =
        forall a. Maybe a
Prelude.Nothing,
      $sel:endpointStatus:EndpointMetadata' :: Maybe EndpointStatus
endpointStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:failureReason:EndpointMetadata' :: Maybe Text
failureReason = forall a. Maybe a
Prelude.Nothing,
      $sel:endpointName:EndpointMetadata' :: Text
endpointName = Text
pEndpointName_
    }

-- | The name of the endpoint configuration.
endpointMetadata_endpointConfigName :: Lens.Lens' EndpointMetadata (Prelude.Maybe Prelude.Text)
endpointMetadata_endpointConfigName :: Lens' EndpointMetadata (Maybe Text)
endpointMetadata_endpointConfigName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EndpointMetadata' {Maybe Text
endpointConfigName :: Maybe Text
$sel:endpointConfigName:EndpointMetadata' :: EndpointMetadata -> Maybe Text
endpointConfigName} -> Maybe Text
endpointConfigName) (\s :: EndpointMetadata
s@EndpointMetadata' {} Maybe Text
a -> EndpointMetadata
s {$sel:endpointConfigName:EndpointMetadata' :: Maybe Text
endpointConfigName = Maybe Text
a} :: EndpointMetadata)

-- | The status of the endpoint. For possible values of the status of an
-- endpoint, see EndpointSummary$EndpointStatus.
endpointMetadata_endpointStatus :: Lens.Lens' EndpointMetadata (Prelude.Maybe EndpointStatus)
endpointMetadata_endpointStatus :: Lens' EndpointMetadata (Maybe EndpointStatus)
endpointMetadata_endpointStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EndpointMetadata' {Maybe EndpointStatus
endpointStatus :: Maybe EndpointStatus
$sel:endpointStatus:EndpointMetadata' :: EndpointMetadata -> Maybe EndpointStatus
endpointStatus} -> Maybe EndpointStatus
endpointStatus) (\s :: EndpointMetadata
s@EndpointMetadata' {} Maybe EndpointStatus
a -> EndpointMetadata
s {$sel:endpointStatus:EndpointMetadata' :: Maybe EndpointStatus
endpointStatus = Maybe EndpointStatus
a} :: EndpointMetadata)

-- | If the status of the endpoint is @Failed@, or the status is @InService@
-- but update operation fails, this provides the reason why it failed.
endpointMetadata_failureReason :: Lens.Lens' EndpointMetadata (Prelude.Maybe Prelude.Text)
endpointMetadata_failureReason :: Lens' EndpointMetadata (Maybe Text)
endpointMetadata_failureReason = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EndpointMetadata' {Maybe Text
failureReason :: Maybe Text
$sel:failureReason:EndpointMetadata' :: EndpointMetadata -> Maybe Text
failureReason} -> Maybe Text
failureReason) (\s :: EndpointMetadata
s@EndpointMetadata' {} Maybe Text
a -> EndpointMetadata
s {$sel:failureReason:EndpointMetadata' :: Maybe Text
failureReason = Maybe Text
a} :: EndpointMetadata)

-- | The name of the endpoint.
endpointMetadata_endpointName :: Lens.Lens' EndpointMetadata Prelude.Text
endpointMetadata_endpointName :: Lens' EndpointMetadata Text
endpointMetadata_endpointName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EndpointMetadata' {Text
endpointName :: Text
$sel:endpointName:EndpointMetadata' :: EndpointMetadata -> Text
endpointName} -> Text
endpointName) (\s :: EndpointMetadata
s@EndpointMetadata' {} Text
a -> EndpointMetadata
s {$sel:endpointName:EndpointMetadata' :: Text
endpointName = Text
a} :: EndpointMetadata)

instance Data.FromJSON EndpointMetadata where
  parseJSON :: Value -> Parser EndpointMetadata
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"EndpointMetadata"
      ( \Object
x ->
          Maybe Text
-> Maybe EndpointStatus -> Maybe Text -> Text -> EndpointMetadata
EndpointMetadata'
            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
"EndpointConfigName")
            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
"EndpointStatus")
            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
"FailureReason")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"EndpointName")
      )

instance Prelude.Hashable EndpointMetadata where
  hashWithSalt :: Int -> EndpointMetadata -> Int
hashWithSalt Int
_salt EndpointMetadata' {Maybe Text
Maybe EndpointStatus
Text
endpointName :: Text
failureReason :: Maybe Text
endpointStatus :: Maybe EndpointStatus
endpointConfigName :: Maybe Text
$sel:endpointName:EndpointMetadata' :: EndpointMetadata -> Text
$sel:failureReason:EndpointMetadata' :: EndpointMetadata -> Maybe Text
$sel:endpointStatus:EndpointMetadata' :: EndpointMetadata -> Maybe EndpointStatus
$sel:endpointConfigName:EndpointMetadata' :: EndpointMetadata -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
endpointConfigName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EndpointStatus
endpointStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
failureReason
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
endpointName

instance Prelude.NFData EndpointMetadata where
  rnf :: EndpointMetadata -> ()
rnf EndpointMetadata' {Maybe Text
Maybe EndpointStatus
Text
endpointName :: Text
failureReason :: Maybe Text
endpointStatus :: Maybe EndpointStatus
endpointConfigName :: Maybe Text
$sel:endpointName:EndpointMetadata' :: EndpointMetadata -> Text
$sel:failureReason:EndpointMetadata' :: EndpointMetadata -> Maybe Text
$sel:endpointStatus:EndpointMetadata' :: EndpointMetadata -> Maybe EndpointStatus
$sel:endpointConfigName:EndpointMetadata' :: EndpointMetadata -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
endpointConfigName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe EndpointStatus
endpointStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
failureReason
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
endpointName