Amazonka.CloudSearch.Types.DoubleOptions

Documentation

data DoubleOptions

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

See: newDoubleOptions smart constructor.

Constructors

DoubleOptions'

Fields

• defaultValue :: Maybe Double

  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

ToQuery DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Methods

toQuery :: DoubleOptions -> QueryString

FromXML DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Methods

parseXML :: [Node] -> Either String DoubleOptions

Generic DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Associated Types

type Rep DoubleOptions :: Type -> Type

Methods

from :: DoubleOptions -> Rep DoubleOptions x

to :: Rep DoubleOptions x -> DoubleOptions

Read DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Methods

readsPrec :: Int -> ReadS DoubleOptions

readList :: ReadS [DoubleOptions]

readPrec :: ReadPrec DoubleOptions

readListPrec :: ReadPrec [DoubleOptions]

Show DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Methods

showsPrec :: Int -> DoubleOptions -> ShowS

show :: DoubleOptions -> String

showList :: [DoubleOptions] -> ShowS

NFData DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Methods

rnf :: DoubleOptions -> ()

Eq DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Methods

(==) :: DoubleOptions -> DoubleOptions -> Bool

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

Hashable DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

Methods

hashWithSalt :: Int -> DoubleOptions -> Int

hash :: DoubleOptions -> Int

type Rep DoubleOptions

Defined in Amazonka.CloudSearch.Types.DoubleOptions

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

newDoubleOptions :: DoubleOptions

Create a value of DoubleOptions 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:DoubleOptions', doubleOptions_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:DoubleOptions', doubleOptions_facetEnabled - Whether facet information can be returned for the field.

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

$sel:searchEnabled:DoubleOptions', doubleOptions_searchEnabled - Whether the contents of the field are searchable.

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

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

doubleOptions_defaultValue :: Lens' DoubleOptions (Maybe Double)

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.

doubleOptions_facetEnabled :: Lens' DoubleOptions (Maybe Bool)

Whether facet information can be returned for the field.

doubleOptions_returnEnabled :: Lens' DoubleOptions (Maybe Bool)

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

doubleOptions_searchEnabled :: Lens' DoubleOptions (Maybe Bool)

Whether the contents of the field are searchable.

doubleOptions_sortEnabled :: Lens' DoubleOptions (Maybe Bool)

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

doubleOptions_sourceField :: Lens' DoubleOptions (Maybe Text)

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