Amazonka.CloudSearch.Types.LatLonOptions

Documentation

data LatLonOptions

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

• defaultValue :: Maybe Text

  A value to use for the field if the field isn't specified for a 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

Instances

ToQuery LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Methods

toQuery :: LatLonOptions -> QueryString

FromXML LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Methods

parseXML :: [Node] -> Either String LatLonOptions

Generic LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Associated Types

type Rep LatLonOptions :: Type -> Type

Methods

from :: LatLonOptions -> Rep LatLonOptions x

to :: Rep LatLonOptions x -> LatLonOptions

Read LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Methods

readsPrec :: Int -> ReadS LatLonOptions

readList :: ReadS [LatLonOptions]

readPrec :: ReadPrec LatLonOptions

readListPrec :: ReadPrec [LatLonOptions]

Show LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Methods

showsPrec :: Int -> LatLonOptions -> ShowS

show :: LatLonOptions -> String

showList :: [LatLonOptions] -> ShowS

NFData LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Methods

rnf :: LatLonOptions -> ()

Eq LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Methods

(==) :: LatLonOptions -> LatLonOptions -> Bool

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

Hashable LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

Methods

hashWithSalt :: Int -> LatLonOptions -> Int

hash :: LatLonOptions -> Int

type Rep LatLonOptions

Defined in Amazonka.CloudSearch.Types.LatLonOptions

type Rep LatLonOptions = D1 ('MetaData "LatLonOptions" "Amazonka.CloudSearch.Types.LatLonOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "LatLonOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (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))))))

newLatLonOptions :: LatLonOptions

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:defaultValue:LatLonOptions', latLonOptions_defaultValue - A value to use for the field if the field isn't specified for a document.

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

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

$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:sourceField:LatLonOptions', latLonOptions_sourceField - Undocumented member.

latLonOptions_defaultValue :: Lens' LatLonOptions (Maybe Text)

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

latLonOptions_facetEnabled :: Lens' LatLonOptions (Maybe Bool)

Whether facet information can be returned for the field.

latLonOptions_returnEnabled :: Lens' LatLonOptions (Maybe Bool)

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

latLonOptions_searchEnabled :: Lens' LatLonOptions (Maybe Bool)

Whether the contents of the field are searchable.

latLonOptions_sortEnabled :: Lens' LatLonOptions (Maybe Bool)

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

latLonOptions_sourceField :: Lens' LatLonOptions (Maybe Text)

Undocumented member.