{-# 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.SuggestionQuery
-- 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.SuggestionQuery 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.PropertyNameQuery

-- | Specified in the GetSearchSuggestions request. Limits the property names
-- that are included in the response.
--
-- /See:/ 'newSuggestionQuery' smart constructor.
data SuggestionQuery = SuggestionQuery'
  { -- | Defines a property name hint. Only property names that begin with the
    -- specified hint are included in the response.
    SuggestionQuery -> Maybe PropertyNameQuery
propertyNameQuery :: Prelude.Maybe PropertyNameQuery
  }
  deriving (SuggestionQuery -> SuggestionQuery -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SuggestionQuery -> SuggestionQuery -> Bool
$c/= :: SuggestionQuery -> SuggestionQuery -> Bool
== :: SuggestionQuery -> SuggestionQuery -> Bool
$c== :: SuggestionQuery -> SuggestionQuery -> Bool
Prelude.Eq, ReadPrec [SuggestionQuery]
ReadPrec SuggestionQuery
Int -> ReadS SuggestionQuery
ReadS [SuggestionQuery]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SuggestionQuery]
$creadListPrec :: ReadPrec [SuggestionQuery]
readPrec :: ReadPrec SuggestionQuery
$creadPrec :: ReadPrec SuggestionQuery
readList :: ReadS [SuggestionQuery]
$creadList :: ReadS [SuggestionQuery]
readsPrec :: Int -> ReadS SuggestionQuery
$creadsPrec :: Int -> ReadS SuggestionQuery
Prelude.Read, Int -> SuggestionQuery -> ShowS
[SuggestionQuery] -> ShowS
SuggestionQuery -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SuggestionQuery] -> ShowS
$cshowList :: [SuggestionQuery] -> ShowS
show :: SuggestionQuery -> String
$cshow :: SuggestionQuery -> String
showsPrec :: Int -> SuggestionQuery -> ShowS
$cshowsPrec :: Int -> SuggestionQuery -> ShowS
Prelude.Show, forall x. Rep SuggestionQuery x -> SuggestionQuery
forall x. SuggestionQuery -> Rep SuggestionQuery x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SuggestionQuery x -> SuggestionQuery
$cfrom :: forall x. SuggestionQuery -> Rep SuggestionQuery x
Prelude.Generic)

-- |
-- Create a value of 'SuggestionQuery' 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:
--
-- 'propertyNameQuery', 'suggestionQuery_propertyNameQuery' - Defines a property name hint. Only property names that begin with the
-- specified hint are included in the response.
newSuggestionQuery ::
  SuggestionQuery
newSuggestionQuery :: SuggestionQuery
newSuggestionQuery =
  SuggestionQuery'
    { $sel:propertyNameQuery:SuggestionQuery' :: Maybe PropertyNameQuery
propertyNameQuery =
        forall a. Maybe a
Prelude.Nothing
    }

-- | Defines a property name hint. Only property names that begin with the
-- specified hint are included in the response.
suggestionQuery_propertyNameQuery :: Lens.Lens' SuggestionQuery (Prelude.Maybe PropertyNameQuery)
suggestionQuery_propertyNameQuery :: Lens' SuggestionQuery (Maybe PropertyNameQuery)
suggestionQuery_propertyNameQuery = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuggestionQuery' {Maybe PropertyNameQuery
propertyNameQuery :: Maybe PropertyNameQuery
$sel:propertyNameQuery:SuggestionQuery' :: SuggestionQuery -> Maybe PropertyNameQuery
propertyNameQuery} -> Maybe PropertyNameQuery
propertyNameQuery) (\s :: SuggestionQuery
s@SuggestionQuery' {} Maybe PropertyNameQuery
a -> SuggestionQuery
s {$sel:propertyNameQuery:SuggestionQuery' :: Maybe PropertyNameQuery
propertyNameQuery = Maybe PropertyNameQuery
a} :: SuggestionQuery)

instance Prelude.Hashable SuggestionQuery where
  hashWithSalt :: Int -> SuggestionQuery -> Int
hashWithSalt Int
_salt SuggestionQuery' {Maybe PropertyNameQuery
propertyNameQuery :: Maybe PropertyNameQuery
$sel:propertyNameQuery:SuggestionQuery' :: SuggestionQuery -> Maybe PropertyNameQuery
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PropertyNameQuery
propertyNameQuery

instance Prelude.NFData SuggestionQuery where
  rnf :: SuggestionQuery -> ()
rnf SuggestionQuery' {Maybe PropertyNameQuery
propertyNameQuery :: Maybe PropertyNameQuery
$sel:propertyNameQuery:SuggestionQuery' :: SuggestionQuery -> Maybe PropertyNameQuery
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe PropertyNameQuery
propertyNameQuery

instance Data.ToJSON SuggestionQuery where
  toJSON :: SuggestionQuery -> Value
toJSON SuggestionQuery' {Maybe PropertyNameQuery
propertyNameQuery :: Maybe PropertyNameQuery
$sel:propertyNameQuery:SuggestionQuery' :: SuggestionQuery -> Maybe PropertyNameQuery
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"PropertyNameQuery" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe PropertyNameQuery
propertyNameQuery
          ]
      )