IndexField.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.CloudSearch.Types.IndexField
-- 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.CloudSearch.Types.IndexField where

import Amazonka.CloudSearch.Types.DateArrayOptions
import Amazonka.CloudSearch.Types.DateOptions
import Amazonka.CloudSearch.Types.DoubleArrayOptions
import Amazonka.CloudSearch.Types.DoubleOptions
import Amazonka.CloudSearch.Types.IndexFieldType
import Amazonka.CloudSearch.Types.IntArrayOptions
import Amazonka.CloudSearch.Types.IntOptions
import Amazonka.CloudSearch.Types.LatLonOptions
import Amazonka.CloudSearch.Types.LiteralArrayOptions
import Amazonka.CloudSearch.Types.LiteralOptions
import Amazonka.CloudSearch.Types.TextArrayOptions
import Amazonka.CloudSearch.Types.TextOptions
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

-- | Configuration information for a field in the index, including its name,
-- type, and options. The supported options depend on the @IndexFieldType@.
--
-- /See:/ 'newIndexField' smart constructor.
data IndexField = IndexField'
  { dateArrayOptions :: Prelude.Maybe DateArrayOptions,
    dateOptions :: Prelude.Maybe DateOptions,
    doubleArrayOptions :: Prelude.Maybe DoubleArrayOptions,
    doubleOptions :: Prelude.Maybe DoubleOptions,
    intArrayOptions :: Prelude.Maybe IntArrayOptions,
    intOptions :: Prelude.Maybe IntOptions,
    latLonOptions :: Prelude.Maybe LatLonOptions,
    literalArrayOptions :: Prelude.Maybe LiteralArrayOptions,
    literalOptions :: Prelude.Maybe LiteralOptions,
    textArrayOptions :: Prelude.Maybe TextArrayOptions,
    textOptions :: Prelude.Maybe TextOptions,
    -- | A string that represents the name of an index field. CloudSearch
    -- supports regular index fields as well as dynamic fields. A dynamic
    -- field\'s name defines a pattern that begins or ends with a wildcard. Any
    -- document fields that don\'t map to a regular index field but do match a
    -- dynamic field\'s pattern are configured with the dynamic field\'s
    -- indexing options.
    --
    -- Regular field names begin with a letter and can contain the following
    -- characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field
    -- names must begin or end with a wildcard (*). The wildcard can also be
    -- the only character in a dynamic field name. Multiple wildcards, and
    -- wildcards embedded within a string are not supported.
    --
    -- The name @score@ is reserved and cannot be used as a field name. To
    -- reference a document\'s ID, you can use the name @_id@.
    indexFieldName :: Prelude.Text,
    indexFieldType :: IndexFieldType
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'IndexField' 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:
--
-- 'dateArrayOptions', 'indexField_dateArrayOptions' - Undocumented member.
--
-- 'dateOptions', 'indexField_dateOptions' - Undocumented member.
--
-- 'doubleArrayOptions', 'indexField_doubleArrayOptions' - Undocumented member.
--
-- 'doubleOptions', 'indexField_doubleOptions' - Undocumented member.
--
-- 'intArrayOptions', 'indexField_intArrayOptions' - Undocumented member.
--
-- 'intOptions', 'indexField_intOptions' - Undocumented member.
--
-- 'latLonOptions', 'indexField_latLonOptions' - Undocumented member.
--
-- 'literalArrayOptions', 'indexField_literalArrayOptions' - Undocumented member.
--
-- 'literalOptions', 'indexField_literalOptions' - Undocumented member.
--
-- 'textArrayOptions', 'indexField_textArrayOptions' - Undocumented member.
--
-- 'textOptions', 'indexField_textOptions' - Undocumented member.
--
-- 'indexFieldName', 'indexField_indexFieldName' - A string that represents the name of an index field. CloudSearch
-- supports regular index fields as well as dynamic fields. A dynamic
-- field\'s name defines a pattern that begins or ends with a wildcard. Any
-- document fields that don\'t map to a regular index field but do match a
-- dynamic field\'s pattern are configured with the dynamic field\'s
-- indexing options.
--
-- Regular field names begin with a letter and can contain the following
-- characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field
-- names must begin or end with a wildcard (*). The wildcard can also be
-- the only character in a dynamic field name. Multiple wildcards, and
-- wildcards embedded within a string are not supported.
--
-- The name @score@ is reserved and cannot be used as a field name. To
-- reference a document\'s ID, you can use the name @_id@.
--
-- 'indexFieldType', 'indexField_indexFieldType' - Undocumented member.
newIndexField ::
  -- | 'indexFieldName'
  Prelude.Text ->
  -- | 'indexFieldType'
  IndexFieldType ->
  IndexField
newIndexField pIndexFieldName_ pIndexFieldType_ =
  IndexField'
    { dateArrayOptions = Prelude.Nothing,
      dateOptions = Prelude.Nothing,
      doubleArrayOptions = Prelude.Nothing,
      doubleOptions = Prelude.Nothing,
      intArrayOptions = Prelude.Nothing,
      intOptions = Prelude.Nothing,
      latLonOptions = Prelude.Nothing,
      literalArrayOptions = Prelude.Nothing,
      literalOptions = Prelude.Nothing,
      textArrayOptions = Prelude.Nothing,
      textOptions = Prelude.Nothing,
      indexFieldName = pIndexFieldName_,
      indexFieldType = pIndexFieldType_
    }

-- | Undocumented member.
indexField_dateArrayOptions :: Lens.Lens' IndexField (Prelude.Maybe DateArrayOptions)
indexField_dateArrayOptions = Lens.lens (\IndexField' {dateArrayOptions} -> dateArrayOptions) (\s@IndexField' {} a -> s {dateArrayOptions = a} :: IndexField)

-- | Undocumented member.
indexField_dateOptions :: Lens.Lens' IndexField (Prelude.Maybe DateOptions)
indexField_dateOptions = Lens.lens (\IndexField' {dateOptions} -> dateOptions) (\s@IndexField' {} a -> s {dateOptions = a} :: IndexField)

-- | Undocumented member.
indexField_doubleArrayOptions :: Lens.Lens' IndexField (Prelude.Maybe DoubleArrayOptions)
indexField_doubleArrayOptions = Lens.lens (\IndexField' {doubleArrayOptions} -> doubleArrayOptions) (\s@IndexField' {} a -> s {doubleArrayOptions = a} :: IndexField)

-- | Undocumented member.
indexField_doubleOptions :: Lens.Lens' IndexField (Prelude.Maybe DoubleOptions)
indexField_doubleOptions = Lens.lens (\IndexField' {doubleOptions} -> doubleOptions) (\s@IndexField' {} a -> s {doubleOptions = a} :: IndexField)

-- | Undocumented member.
indexField_intArrayOptions :: Lens.Lens' IndexField (Prelude.Maybe IntArrayOptions)
indexField_intArrayOptions = Lens.lens (\IndexField' {intArrayOptions} -> intArrayOptions) (\s@IndexField' {} a -> s {intArrayOptions = a} :: IndexField)

-- | Undocumented member.
indexField_intOptions :: Lens.Lens' IndexField (Prelude.Maybe IntOptions)
indexField_intOptions = Lens.lens (\IndexField' {intOptions} -> intOptions) (\s@IndexField' {} a -> s {intOptions = a} :: IndexField)

-- | Undocumented member.
indexField_latLonOptions :: Lens.Lens' IndexField (Prelude.Maybe LatLonOptions)
indexField_latLonOptions = Lens.lens (\IndexField' {latLonOptions} -> latLonOptions) (\s@IndexField' {} a -> s {latLonOptions = a} :: IndexField)

-- | Undocumented member.
indexField_literalArrayOptions :: Lens.Lens' IndexField (Prelude.Maybe LiteralArrayOptions)
indexField_literalArrayOptions = Lens.lens (\IndexField' {literalArrayOptions} -> literalArrayOptions) (\s@IndexField' {} a -> s {literalArrayOptions = a} :: IndexField)

-- | Undocumented member.
indexField_literalOptions :: Lens.Lens' IndexField (Prelude.Maybe LiteralOptions)
indexField_literalOptions = Lens.lens (\IndexField' {literalOptions} -> literalOptions) (\s@IndexField' {} a -> s {literalOptions = a} :: IndexField)

-- | Undocumented member.
indexField_textArrayOptions :: Lens.Lens' IndexField (Prelude.Maybe TextArrayOptions)
indexField_textArrayOptions = Lens.lens (\IndexField' {textArrayOptions} -> textArrayOptions) (\s@IndexField' {} a -> s {textArrayOptions = a} :: IndexField)

-- | Undocumented member.
indexField_textOptions :: Lens.Lens' IndexField (Prelude.Maybe TextOptions)
indexField_textOptions = Lens.lens (\IndexField' {textOptions} -> textOptions) (\s@IndexField' {} a -> s {textOptions = a} :: IndexField)

-- | A string that represents the name of an index field. CloudSearch
-- supports regular index fields as well as dynamic fields. A dynamic
-- field\'s name defines a pattern that begins or ends with a wildcard. Any
-- document fields that don\'t map to a regular index field but do match a
-- dynamic field\'s pattern are configured with the dynamic field\'s
-- indexing options.
--
-- Regular field names begin with a letter and can contain the following
-- characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field
-- names must begin or end with a wildcard (*). The wildcard can also be
-- the only character in a dynamic field name. Multiple wildcards, and
-- wildcards embedded within a string are not supported.
--
-- The name @score@ is reserved and cannot be used as a field name. To
-- reference a document\'s ID, you can use the name @_id@.
indexField_indexFieldName :: Lens.Lens' IndexField Prelude.Text
indexField_indexFieldName = Lens.lens (\IndexField' {indexFieldName} -> indexFieldName) (\s@IndexField' {} a -> s {indexFieldName = a} :: IndexField)

-- | Undocumented member.
indexField_indexFieldType :: Lens.Lens' IndexField IndexFieldType
indexField_indexFieldType = Lens.lens (\IndexField' {indexFieldType} -> indexFieldType) (\s@IndexField' {} a -> s {indexFieldType = a} :: IndexField)

instance Data.FromXML IndexField where
  parseXML x =
    IndexField'
      Prelude.<$> (x Data..@? "DateArrayOptions")
      Prelude.<*> (x Data..@? "DateOptions")
      Prelude.<*> (x Data..@? "DoubleArrayOptions")
      Prelude.<*> (x Data..@? "DoubleOptions")
      Prelude.<*> (x Data..@? "IntArrayOptions")
      Prelude.<*> (x Data..@? "IntOptions")
      Prelude.<*> (x Data..@? "LatLonOptions")
      Prelude.<*> (x Data..@? "LiteralArrayOptions")
      Prelude.<*> (x Data..@? "LiteralOptions")
      Prelude.<*> (x Data..@? "TextArrayOptions")
      Prelude.<*> (x Data..@? "TextOptions")
      Prelude.<*> (x Data..@ "IndexFieldName")
      Prelude.<*> (x Data..@ "IndexFieldType")

instance Prelude.Hashable IndexField where
  hashWithSalt _salt IndexField' {..} =
    _salt
      `Prelude.hashWithSalt` dateArrayOptions
      `Prelude.hashWithSalt` dateOptions
      `Prelude.hashWithSalt` doubleArrayOptions
      `Prelude.hashWithSalt` doubleOptions
      `Prelude.hashWithSalt` intArrayOptions
      `Prelude.hashWithSalt` intOptions
      `Prelude.hashWithSalt` latLonOptions
      `Prelude.hashWithSalt` literalArrayOptions
      `Prelude.hashWithSalt` literalOptions
      `Prelude.hashWithSalt` textArrayOptions
      `Prelude.hashWithSalt` textOptions
      `Prelude.hashWithSalt` indexFieldName
      `Prelude.hashWithSalt` indexFieldType

instance Prelude.NFData IndexField where
  rnf IndexField' {..} =
    Prelude.rnf dateArrayOptions
      `Prelude.seq` Prelude.rnf dateOptions
      `Prelude.seq` Prelude.rnf doubleArrayOptions
      `Prelude.seq` Prelude.rnf doubleOptions
      `Prelude.seq` Prelude.rnf intArrayOptions
      `Prelude.seq` Prelude.rnf intOptions
      `Prelude.seq` Prelude.rnf latLonOptions
      `Prelude.seq` Prelude.rnf literalArrayOptions
      `Prelude.seq` Prelude.rnf literalOptions
      `Prelude.seq` Prelude.rnf textArrayOptions
      `Prelude.seq` Prelude.rnf textOptions
      `Prelude.seq` Prelude.rnf indexFieldName
      `Prelude.seq` Prelude.rnf indexFieldType

instance Data.ToQuery IndexField where
  toQuery IndexField' {..} =
    Prelude.mconcat
      [ "DateArrayOptions" Data.=: dateArrayOptions,
        "DateOptions" Data.=: dateOptions,
        "DoubleArrayOptions" Data.=: doubleArrayOptions,
        "DoubleOptions" Data.=: doubleOptions,
        "IntArrayOptions" Data.=: intArrayOptions,
        "IntOptions" Data.=: intOptions,
        "LatLonOptions" Data.=: latLonOptions,
        "LiteralArrayOptions" Data.=: literalArrayOptions,
        "LiteralOptions" Data.=: literalOptions,
        "TextArrayOptions" Data.=: textArrayOptions,
        "TextOptions" Data.=: textOptions,
        "IndexFieldName" Data.=: indexFieldName,
        "IndexFieldType" Data.=: indexFieldType
      ]