libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudSearch.Types.DateOptions

Description

 
Synopsis

Documentation

data DateOptions Source #

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

Instances

Instances details
Eq DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

Read DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

Show DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

Generic DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

Associated Types

type Rep DateOptions :: Type -> Type #

NFData DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

Methods

rnf :: DateOptions -> () #

Hashable DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

ToQuery DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

FromXML DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

type Rep DateOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.DateOptions

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

newDateOptions :: DateOptions Source #

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:sourceField:DateOptions', dateOptions_sourceField - Undocumented member.

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

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

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

dateOptions_returnEnabled :: Lens' DateOptions (Maybe Bool) Source #

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

dateOptions_facetEnabled :: Lens' DateOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

dateOptions_searchEnabled :: Lens' DateOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

dateOptions_sortEnabled :: Lens' DateOptions (Maybe Bool) Source #

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

dateOptions_defaultValue :: Lens' DateOptions (Maybe Text) Source #

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