Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface 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.

Hierarchy

  • LatLonOptions

Index

Properties

Optional DefaultValue

DefaultValue: undefined | string

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

Optional FacetEnabled

FacetEnabled: undefined | false | true

Whether facet information can be returned for the field.

Optional ReturnEnabled

ReturnEnabled: undefined | false | true

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

Optional SearchEnabled

SearchEnabled: undefined | false | true

Whether the contents of the field are searchable.

Optional SortEnabled

SortEnabled: undefined | false | true

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

Optional SourceField

SourceField: undefined | string

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.