Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudSearch.Types.IntOptions

Description

Synopsis

Documentation

data IntOptions Source #

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

See: newIntOptions smart constructor.

Constructors

IntOptions'

Fields

defaultValue :: Maybe Integer
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
facetEnabled :: Maybe Bool
Whether facet information can be returned for the field.
returnEnabled :: Maybe Bool
Whether the contents of the field can be returned in the search results.
searchEnabled :: Maybe Bool
Whether the contents of the field are searchable.
sortEnabled :: Maybe Bool
Whether the field can be used to sort the search results.
sourceField :: Maybe Text
The name of the source field to map to the field.

Instances

Instances details

ToQuery IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Methods toQuery :: IntOptions -> QueryString #
FromXML IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Methods parseXML :: [Node] -> Either String IntOptions #
Generic IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Associated Types type Rep IntOptions :: Type -> Type # Methods from :: IntOptions -> Rep IntOptions x # to :: Rep IntOptions x -> IntOptions #
Read IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Methods readsPrec :: Int -> ReadS IntOptions # readList :: ReadS [IntOptions] # readPrec :: ReadPrec IntOptions # readListPrec :: ReadPrec [IntOptions] #
Show IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Methods showsPrec :: Int -> IntOptions -> ShowS # show :: IntOptions -> String # showList :: [IntOptions] -> ShowS #
NFData IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Methods rnf :: IntOptions -> () #
Eq IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Methods (==) :: IntOptions -> IntOptions -> Bool # (/=) :: IntOptions -> IntOptions -> Bool #
Hashable IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions Methods hashWithSalt :: Int -> IntOptions -> Int # hash :: IntOptions -> Int #
type Rep IntOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.IntOptions type Rep IntOptions = D1 ('MetaData "IntOptions" "Amazonka.CloudSearch.Types.IntOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "IntOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "facetEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "returnEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "searchEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "sortEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sourceField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIntOptions :: IntOptions Source #

Create a value of IntOptions 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:defaultValue:IntOptions', intOptions_defaultValue - A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

$sel:facetEnabled:IntOptions', intOptions_facetEnabled - Whether facet information can be returned for the field.

$sel:returnEnabled:IntOptions', intOptions_returnEnabled - Whether the contents of the field can be returned in the search results.

$sel:searchEnabled:IntOptions', intOptions_searchEnabled - Whether the contents of the field are searchable.

$sel:sortEnabled:IntOptions', intOptions_sortEnabled - Whether the field can be used to sort the search results.

$sel:sourceField:IntOptions', intOptions_sourceField - The name of the source field to map to the field.

intOptions_defaultValue :: Lens' IntOptions (Maybe Integer) Source #

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

intOptions_facetEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

intOptions_returnEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether the contents of the field can be returned in the search results.

intOptions_searchEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

intOptions_sortEnabled :: Lens' IntOptions (Maybe Bool) Source #

Whether the field can be used to sort the search results.

intOptions_sourceField :: Lens' IntOptions (Maybe Text) Source #

The name of the source field to map to the field.