{-# 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.SearchRecord
-- 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.SearchRecord 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.Endpoint
import Amazonka.SageMaker.Types.Experiment
import Amazonka.SageMaker.Types.FeatureGroup
import Amazonka.SageMaker.Types.FeatureMetadata
import Amazonka.SageMaker.Types.HyperParameterTuningJobSearchEntity
import Amazonka.SageMaker.Types.ModelCard
import Amazonka.SageMaker.Types.ModelDashboardModel
import Amazonka.SageMaker.Types.ModelPackage
import Amazonka.SageMaker.Types.ModelPackageGroup
import Amazonka.SageMaker.Types.Pipeline
import Amazonka.SageMaker.Types.PipelineExecution
import Amazonka.SageMaker.Types.Project
import Amazonka.SageMaker.Types.TrainingJob
import Amazonka.SageMaker.Types.Trial
import Amazonka.SageMaker.Types.TrialComponent

-- | A single resource returned as part of the Search API response.
--
-- /See:/ 'newSearchRecord' smart constructor.
data SearchRecord = SearchRecord'
  { endpoint :: Prelude.Maybe Endpoint,
    -- | The properties of an experiment.
    experiment :: Prelude.Maybe Experiment,
    featureGroup :: Prelude.Maybe FeatureGroup,
    -- | The feature metadata used to search through the features.
    featureMetadata :: Prelude.Maybe FeatureMetadata,
    -- | The properties of a hyperparameter tuning job.
    hyperParameterTuningJob :: Prelude.Maybe HyperParameterTuningJobSearchEntity,
    model :: Prelude.Maybe ModelDashboardModel,
    -- | An Amazon SageMaker Model Card that documents details about a machine
    -- learning model.
    modelCard :: Prelude.Maybe ModelCard,
    modelPackage :: Prelude.Maybe ModelPackage,
    modelPackageGroup :: Prelude.Maybe ModelPackageGroup,
    pipeline :: Prelude.Maybe Pipeline,
    pipelineExecution :: Prelude.Maybe PipelineExecution,
    -- | The properties of a project.
    project :: Prelude.Maybe Project,
    -- | The properties of a training job.
    trainingJob :: Prelude.Maybe TrainingJob,
    -- | The properties of a trial.
    trial :: Prelude.Maybe Trial,
    -- | The properties of a trial component.
    trialComponent :: Prelude.Maybe TrialComponent
  }
  deriving (Prelude.Eq, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'SearchRecord' 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:
--
-- 'endpoint', 'searchRecord_endpoint' - Undocumented member.
--
-- 'experiment', 'searchRecord_experiment' - The properties of an experiment.
--
-- 'featureGroup', 'searchRecord_featureGroup' - Undocumented member.
--
-- 'featureMetadata', 'searchRecord_featureMetadata' - The feature metadata used to search through the features.
--
-- 'hyperParameterTuningJob', 'searchRecord_hyperParameterTuningJob' - The properties of a hyperparameter tuning job.
--
-- 'model', 'searchRecord_model' - Undocumented member.
--
-- 'modelCard', 'searchRecord_modelCard' - An Amazon SageMaker Model Card that documents details about a machine
-- learning model.
--
-- 'modelPackage', 'searchRecord_modelPackage' - Undocumented member.
--
-- 'modelPackageGroup', 'searchRecord_modelPackageGroup' - Undocumented member.
--
-- 'pipeline', 'searchRecord_pipeline' - Undocumented member.
--
-- 'pipelineExecution', 'searchRecord_pipelineExecution' - Undocumented member.
--
-- 'project', 'searchRecord_project' - The properties of a project.
--
-- 'trainingJob', 'searchRecord_trainingJob' - The properties of a training job.
--
-- 'trial', 'searchRecord_trial' - The properties of a trial.
--
-- 'trialComponent', 'searchRecord_trialComponent' - The properties of a trial component.
newSearchRecord ::
  SearchRecord
newSearchRecord =
  SearchRecord'
    { endpoint = Prelude.Nothing,
      experiment = Prelude.Nothing,
      featureGroup = Prelude.Nothing,
      featureMetadata = Prelude.Nothing,
      hyperParameterTuningJob = Prelude.Nothing,
      model = Prelude.Nothing,
      modelCard = Prelude.Nothing,
      modelPackage = Prelude.Nothing,
      modelPackageGroup = Prelude.Nothing,
      pipeline = Prelude.Nothing,
      pipelineExecution = Prelude.Nothing,
      project = Prelude.Nothing,
      trainingJob = Prelude.Nothing,
      trial = Prelude.Nothing,
      trialComponent = Prelude.Nothing
    }

-- | Undocumented member.
searchRecord_endpoint :: Lens.Lens' SearchRecord (Prelude.Maybe Endpoint)
searchRecord_endpoint = Lens.lens (\SearchRecord' {endpoint} -> endpoint) (\s@SearchRecord' {} a -> s {endpoint = a} :: SearchRecord)

-- | The properties of an experiment.
searchRecord_experiment :: Lens.Lens' SearchRecord (Prelude.Maybe Experiment)
searchRecord_experiment = Lens.lens (\SearchRecord' {experiment} -> experiment) (\s@SearchRecord' {} a -> s {experiment = a} :: SearchRecord)

-- | Undocumented member.
searchRecord_featureGroup :: Lens.Lens' SearchRecord (Prelude.Maybe FeatureGroup)
searchRecord_featureGroup = Lens.lens (\SearchRecord' {featureGroup} -> featureGroup) (\s@SearchRecord' {} a -> s {featureGroup = a} :: SearchRecord)

-- | The feature metadata used to search through the features.
searchRecord_featureMetadata :: Lens.Lens' SearchRecord (Prelude.Maybe FeatureMetadata)
searchRecord_featureMetadata = Lens.lens (\SearchRecord' {featureMetadata} -> featureMetadata) (\s@SearchRecord' {} a -> s {featureMetadata = a} :: SearchRecord)

-- | The properties of a hyperparameter tuning job.
searchRecord_hyperParameterTuningJob :: Lens.Lens' SearchRecord (Prelude.Maybe HyperParameterTuningJobSearchEntity)
searchRecord_hyperParameterTuningJob = Lens.lens (\SearchRecord' {hyperParameterTuningJob} -> hyperParameterTuningJob) (\s@SearchRecord' {} a -> s {hyperParameterTuningJob = a} :: SearchRecord)

-- | Undocumented member.
searchRecord_model :: Lens.Lens' SearchRecord (Prelude.Maybe ModelDashboardModel)
searchRecord_model = Lens.lens (\SearchRecord' {model} -> model) (\s@SearchRecord' {} a -> s {model = a} :: SearchRecord)

-- | An Amazon SageMaker Model Card that documents details about a machine
-- learning model.
searchRecord_modelCard :: Lens.Lens' SearchRecord (Prelude.Maybe ModelCard)
searchRecord_modelCard = Lens.lens (\SearchRecord' {modelCard} -> modelCard) (\s@SearchRecord' {} a -> s {modelCard = a} :: SearchRecord)

-- | Undocumented member.
searchRecord_modelPackage :: Lens.Lens' SearchRecord (Prelude.Maybe ModelPackage)
searchRecord_modelPackage = Lens.lens (\SearchRecord' {modelPackage} -> modelPackage) (\s@SearchRecord' {} a -> s {modelPackage = a} :: SearchRecord)

-- | Undocumented member.
searchRecord_modelPackageGroup :: Lens.Lens' SearchRecord (Prelude.Maybe ModelPackageGroup)
searchRecord_modelPackageGroup = Lens.lens (\SearchRecord' {modelPackageGroup} -> modelPackageGroup) (\s@SearchRecord' {} a -> s {modelPackageGroup = a} :: SearchRecord)

-- | Undocumented member.
searchRecord_pipeline :: Lens.Lens' SearchRecord (Prelude.Maybe Pipeline)
searchRecord_pipeline = Lens.lens (\SearchRecord' {pipeline} -> pipeline) (\s@SearchRecord' {} a -> s {pipeline = a} :: SearchRecord)

-- | Undocumented member.
searchRecord_pipelineExecution :: Lens.Lens' SearchRecord (Prelude.Maybe PipelineExecution)
searchRecord_pipelineExecution = Lens.lens (\SearchRecord' {pipelineExecution} -> pipelineExecution) (\s@SearchRecord' {} a -> s {pipelineExecution = a} :: SearchRecord)

-- | The properties of a project.
searchRecord_project :: Lens.Lens' SearchRecord (Prelude.Maybe Project)
searchRecord_project = Lens.lens (\SearchRecord' {project} -> project) (\s@SearchRecord' {} a -> s {project = a} :: SearchRecord)

-- | The properties of a training job.
searchRecord_trainingJob :: Lens.Lens' SearchRecord (Prelude.Maybe TrainingJob)
searchRecord_trainingJob = Lens.lens (\SearchRecord' {trainingJob} -> trainingJob) (\s@SearchRecord' {} a -> s {trainingJob = a} :: SearchRecord)

-- | The properties of a trial.
searchRecord_trial :: Lens.Lens' SearchRecord (Prelude.Maybe Trial)
searchRecord_trial = Lens.lens (\SearchRecord' {trial} -> trial) (\s@SearchRecord' {} a -> s {trial = a} :: SearchRecord)

-- | The properties of a trial component.
searchRecord_trialComponent :: Lens.Lens' SearchRecord (Prelude.Maybe TrialComponent)
searchRecord_trialComponent = Lens.lens (\SearchRecord' {trialComponent} -> trialComponent) (\s@SearchRecord' {} a -> s {trialComponent = a} :: SearchRecord)

instance Data.FromJSON SearchRecord where
  parseJSON =
    Data.withObject
      "SearchRecord"
      ( \x ->
          SearchRecord'
            Prelude.<$> (x Data..:? "Endpoint")
            Prelude.<*> (x Data..:? "Experiment")
            Prelude.<*> (x Data..:? "FeatureGroup")
            Prelude.<*> (x Data..:? "FeatureMetadata")
            Prelude.<*> (x Data..:? "HyperParameterTuningJob")
            Prelude.<*> (x Data..:? "Model")
            Prelude.<*> (x Data..:? "ModelCard")
            Prelude.<*> (x Data..:? "ModelPackage")
            Prelude.<*> (x Data..:? "ModelPackageGroup")
            Prelude.<*> (x Data..:? "Pipeline")
            Prelude.<*> (x Data..:? "PipelineExecution")
            Prelude.<*> (x Data..:? "Project")
            Prelude.<*> (x Data..:? "TrainingJob")
            Prelude.<*> (x Data..:? "Trial")
            Prelude.<*> (x Data..:? "TrialComponent")
      )

instance Prelude.Hashable SearchRecord where
  hashWithSalt _salt SearchRecord' {..} =
    _salt
      `Prelude.hashWithSalt` endpoint
      `Prelude.hashWithSalt` experiment
      `Prelude.hashWithSalt` featureGroup
      `Prelude.hashWithSalt` featureMetadata
      `Prelude.hashWithSalt` hyperParameterTuningJob
      `Prelude.hashWithSalt` model
      `Prelude.hashWithSalt` modelCard
      `Prelude.hashWithSalt` modelPackage
      `Prelude.hashWithSalt` modelPackageGroup
      `Prelude.hashWithSalt` pipeline
      `Prelude.hashWithSalt` pipelineExecution
      `Prelude.hashWithSalt` project
      `Prelude.hashWithSalt` trainingJob
      `Prelude.hashWithSalt` trial
      `Prelude.hashWithSalt` trialComponent

instance Prelude.NFData SearchRecord where
  rnf SearchRecord' {..} =
    Prelude.rnf endpoint
      `Prelude.seq` Prelude.rnf experiment
      `Prelude.seq` Prelude.rnf featureGroup
      `Prelude.seq` Prelude.rnf featureMetadata
      `Prelude.seq` Prelude.rnf hyperParameterTuningJob
      `Prelude.seq` Prelude.rnf model
      `Prelude.seq` Prelude.rnf modelCard
      `Prelude.seq` Prelude.rnf modelPackage
      `Prelude.seq` Prelude.rnf modelPackageGroup
      `Prelude.seq` Prelude.rnf pipeline
      `Prelude.seq` Prelude.rnf pipelineExecution
      `Prelude.seq` Prelude.rnf project
      `Prelude.seq` Prelude.rnf trainingJob
      `Prelude.seq` Prelude.rnf trial
      `Prelude.seq` Prelude.rnf trialComponent