Amazonka.CloudSearch.Types.DateOptions

Documentation

data DateOptions

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

See: newDateOptions smart constructor.

Constructors

DateOptions'

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 DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

toQuery :: DateOptions -> QueryString

FromXML DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

parseXML :: [Node] -> Either String DateOptions

Generic DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Associated Types

type Rep DateOptions :: Type -> Type

Methods

from :: DateOptions -> Rep DateOptions x

to :: Rep DateOptions x -> DateOptions

Read DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

readsPrec :: Int -> ReadS DateOptions

readList :: ReadS [DateOptions]

readPrec :: ReadPrec DateOptions

readListPrec :: ReadPrec [DateOptions]

Show DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

showsPrec :: Int -> DateOptions -> ShowS

show :: DateOptions -> String

showList :: [DateOptions] -> ShowS

NFData DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

rnf :: DateOptions -> ()

Eq DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

(==) :: DateOptions -> DateOptions -> Bool

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

Hashable DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

hashWithSalt :: Int -> DateOptions -> Int

hash :: DateOptions -> Int

type Rep DateOptions

Defined in Amazonka.CloudSearch.Types.DateOptions

type Rep DateOptions = D1 ('MetaData "DateOptions" "Amazonka.CloudSearch.Types.DateOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DateOptions'" '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))))))

newDateOptions :: DateOptions

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

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

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

$sel:searchEnabled:DateOptions', dateOptions_searchEnabled - Whether the contents of the field are searchable.

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

$sel:sourceField:DateOptions', dateOptions_sourceField - Undocumented member.

dateOptions_defaultValue :: Lens' DateOptions (Maybe Text)

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

dateOptions_facetEnabled :: Lens' DateOptions (Maybe Bool)

Whether facet information can be returned for the field.

dateOptions_returnEnabled :: Lens' DateOptions (Maybe Bool)

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

dateOptions_searchEnabled :: Lens' DateOptions (Maybe Bool)

Whether the contents of the field are searchable.

dateOptions_sortEnabled :: Lens' DateOptions (Maybe Bool)

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

dateOptions_sourceField :: Lens' DateOptions (Maybe Text)

Undocumented member.