Amazonka.CloudSearch.Types.DateArrayOptions

Documentation

data DateArrayOptions

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

See: newDateArrayOptions smart constructor.

Constructors

DateArrayOptions'

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.

• sourceFields :: Maybe Text

  A list of source fields to map to the field.

Instances

ToQuery DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Methods

toQuery :: DateArrayOptions -> QueryString

FromXML DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Methods

parseXML :: [Node] -> Either String DateArrayOptions

Generic DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Associated Types

type Rep DateArrayOptions :: Type -> Type

Methods

from :: DateArrayOptions -> Rep DateArrayOptions x

to :: Rep DateArrayOptions x -> DateArrayOptions

Read DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Methods

readsPrec :: Int -> ReadS DateArrayOptions

readList :: ReadS [DateArrayOptions]

readPrec :: ReadPrec DateArrayOptions

readListPrec :: ReadPrec [DateArrayOptions]

Show DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Methods

showsPrec :: Int -> DateArrayOptions -> ShowS

show :: DateArrayOptions -> String

showList :: [DateArrayOptions] -> ShowS

NFData DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Methods

rnf :: DateArrayOptions -> ()

Eq DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Methods

(==) :: DateArrayOptions -> DateArrayOptions -> Bool

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

Hashable DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

Methods

hashWithSalt :: Int -> DateArrayOptions -> Int

hash :: DateArrayOptions -> Int

type Rep DateArrayOptions

Defined in Amazonka.CloudSearch.Types.DateArrayOptions

type Rep DateArrayOptions = D1 ('MetaData "DateArrayOptions" "Amazonka.CloudSearch.Types.DateArrayOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DateArrayOptions'" '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 "sourceFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDateArrayOptions :: DateArrayOptions

Create a value of DateArrayOptions 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:DateArrayOptions', dateArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a document.

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

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

$sel:searchEnabled:DateArrayOptions', dateArrayOptions_searchEnabled - Whether the contents of the field are searchable.

$sel:sourceFields:DateArrayOptions', dateArrayOptions_sourceFields - A list of source fields to map to the field.

dateArrayOptions_defaultValue :: Lens' DateArrayOptions (Maybe Text)

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

dateArrayOptions_facetEnabled :: Lens' DateArrayOptions (Maybe Bool)

Whether facet information can be returned for the field.

dateArrayOptions_returnEnabled :: Lens' DateArrayOptions (Maybe Bool)

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

dateArrayOptions_searchEnabled :: Lens' DateArrayOptions (Maybe Bool)

Whether the contents of the field are searchable.

dateArrayOptions_sourceFields :: Lens' DateArrayOptions (Maybe Text)

A list of source fields to map to the field.