Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudSearch.Types.LatLonOptions

Description

Documentation

data LatLonOptions Source #

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

See: newLatLonOptions smart constructor.

Constructors

LatLonOptions'

Fields

sourceField :: Maybe Text
returnEnabled :: Maybe Bool
Whether the contents of the field can be returned in the search results.
facetEnabled :: Maybe Bool
Whether facet information can be returned for the field.
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.
defaultValue :: Maybe Text
A value to use for the field if the field isn't specified for a document.

Instances

Instances details

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

newLatLonOptions :: LatLonOptions Source #

Create a value of LatLonOptions 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:sourceField:LatLonOptions', latLonOptions_sourceField - Undocumented member.

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

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

$sel:searchEnabled:LatLonOptions', latLonOptions_searchEnabled - Whether the contents of the field are searchable.

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

$sel:defaultValue:LatLonOptions', latLonOptions_defaultValue - A value to use for the field if the field isn't specified for a document.

latLonOptions_sourceField :: Lens' LatLonOptions (Maybe Text) Source #

Undocumented member.

latLonOptions_returnEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

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

latLonOptions_facetEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

latLonOptions_searchEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

latLonOptions_sortEnabled :: Lens' LatLonOptions (Maybe Bool) Source #

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

latLonOptions_defaultValue :: Lens' LatLonOptions (Maybe Text) Source #

A value to use for the field if the field isn't specified for a document.