Amazonka.CloudSearch.Types.IndexField

Documentation

data IndexField

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.

Constructors

IndexField'

Fields

• dateArrayOptions :: Maybe DateArrayOptions
• dateOptions :: Maybe DateOptions
• doubleArrayOptions :: Maybe DoubleArrayOptions
• doubleOptions :: Maybe DoubleOptions
• intArrayOptions :: Maybe IntArrayOptions
• intOptions :: Maybe IntOptions
• latLonOptions :: Maybe LatLonOptions
• literalArrayOptions :: Maybe LiteralArrayOptions
• literalOptions :: Maybe LiteralOptions
• textArrayOptions :: Maybe TextArrayOptions
• textOptions :: Maybe TextOptions
• indexFieldName :: Text

  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 :: IndexFieldType

Instances

ToQuery IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Methods

toQuery :: IndexField -> QueryString

FromXML IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Methods

parseXML :: [Node] -> Either String IndexField

Generic IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Associated Types

type Rep IndexField :: Type -> Type

Methods

from :: IndexField -> Rep IndexField x

to :: Rep IndexField x -> IndexField

Read IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Methods

readsPrec :: Int -> ReadS IndexField

readList :: ReadS [IndexField]

readPrec :: ReadPrec IndexField

readListPrec :: ReadPrec [IndexField]

Show IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Methods

showsPrec :: Int -> IndexField -> ShowS

show :: IndexField -> String

showList :: [IndexField] -> ShowS

NFData IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Methods

rnf :: IndexField -> ()

Eq IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Methods

(==) :: IndexField -> IndexField -> Bool

(/=) :: IndexField -> IndexField -> Bool

Hashable IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

Methods

hashWithSalt :: Int -> IndexField -> Int

hash :: IndexField -> Int

type Rep IndexField

Defined in Amazonka.CloudSearch.Types.IndexField

type Rep IndexField = D1 ('MetaData "IndexField" "Amazonka.CloudSearch.Types.IndexField" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "IndexField'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dateArrayOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DateArrayOptions)) :*: (S1 ('MetaSel ('Just "dateOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DateOptions)) :*: S1 ('MetaSel ('Just "doubleArrayOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DoubleArrayOptions)))) :*: (S1 ('MetaSel ('Just "doubleOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DoubleOptions)) :*: (S1 ('MetaSel ('Just "intArrayOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntArrayOptions)) :*: S1 ('MetaSel ('Just "intOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntOptions))))) :*: ((S1 ('MetaSel ('Just "latLonOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LatLonOptions)) :*: (S1 ('MetaSel ('Just "literalArrayOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LiteralArrayOptions)) :*: S1 ('MetaSel ('Just "literalOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LiteralOptions)))) :*: ((S1 ('MetaSel ('Just "textArrayOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextArrayOptions)) :*: S1 ('MetaSel ('Just "textOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextOptions))) :*: (S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexFieldType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IndexFieldType))))))

newIndexField

Arguments

:: Text

$sel:indexFieldName:IndexField'

-> IndexFieldType

$sel:indexFieldType:IndexField'

-> IndexField

Create a value of IndexField with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dateArrayOptions:IndexField', indexField_dateArrayOptions - Undocumented member.

$sel:dateOptions:IndexField', indexField_dateOptions - Undocumented member.

$sel:doubleArrayOptions:IndexField', indexField_doubleArrayOptions - Undocumented member.

$sel:doubleOptions:IndexField', indexField_doubleOptions - Undocumented member.

$sel:intArrayOptions:IndexField', indexField_intArrayOptions - Undocumented member.

$sel:intOptions:IndexField', indexField_intOptions - Undocumented member.

$sel:latLonOptions:IndexField', indexField_latLonOptions - Undocumented member.

$sel:literalArrayOptions:IndexField', indexField_literalArrayOptions - Undocumented member.

$sel:literalOptions:IndexField', indexField_literalOptions - Undocumented member.

$sel:textArrayOptions:IndexField', indexField_textArrayOptions - Undocumented member.

$sel:textOptions:IndexField', indexField_textOptions - Undocumented member.

$sel:indexFieldName:IndexField', 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.

$sel:indexFieldType:IndexField', indexField_indexFieldType - Undocumented member.

indexField_dateArrayOptions :: Lens' IndexField (Maybe DateArrayOptions)

Undocumented member.

indexField_dateOptions :: Lens' IndexField (Maybe DateOptions)

Undocumented member.

indexField_doubleArrayOptions :: Lens' IndexField (Maybe DoubleArrayOptions)

Undocumented member.

indexField_doubleOptions :: Lens' IndexField (Maybe DoubleOptions)

Undocumented member.

indexField_intArrayOptions :: Lens' IndexField (Maybe IntArrayOptions)

Undocumented member.

indexField_intOptions :: Lens' IndexField (Maybe IntOptions)

Undocumented member.

indexField_latLonOptions :: Lens' IndexField (Maybe LatLonOptions)

Undocumented member.

indexField_literalArrayOptions :: Lens' IndexField (Maybe LiteralArrayOptions)

Undocumented member.

indexField_literalOptions :: Lens' IndexField (Maybe LiteralOptions)

Undocumented member.

indexField_textArrayOptions :: Lens' IndexField (Maybe TextArrayOptions)

Undocumented member.

indexField_textOptions :: Lens' IndexField (Maybe TextOptions)

Undocumented member.

indexField_indexFieldName :: Lens' IndexField Text

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_indexFieldType :: Lens' IndexField IndexFieldType

Undocumented member.