Module params

Value types accepted by leaf query clauses

Structs

Coordinate

Represents a point in two dimensional space

GeoLocation

Represents a point in two dimensional space

Number

Numeric enum

PointInTime

A point in time (PIT) is a point that represents a consistent view of the data at that time.

Terms

A collection of terms

Text

Search text

Enums

Byte

Whenever the byte size of data needs to be specified, e.g. when setting a buffer size parameter, the value must specify the unit, like 10kb for 10 kilobytes. Note that these units use powers of 1024, so 1kb means 1024 bytes.

CalendarInterval

Calendar-aware intervals are configured with the calendar_interval parameter. You can specify calendar intervals using the unit name, such as month, or as a single unit quantity, such as 1M. For example,day and 1d are equivalent. Multiple quantities, such as 2d, are not supported.

Date

Time variants to serialize

Distance

Wherever distances need to be specified, such as the distance parameter in the Geo-distance ), the default unit is meters if none is specified. Distances can be specified in other units, such as "1km" or "2mi" (2 miles).

DistanceUnit

Wherever distances need to be specified, such as the distance parameter in the Geo-distance ), the default unit is meters if none is specified. Distances can be specified in other units, such as "1km" or "2mi" (2 miles).

GeoDistanceType

How to compute the distance

GeoShape

The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons. It should be used when either the data being indexed or the queries being executed contain shapes other than just points.

ScoreMode

The way the scores are combined can be controlled

ScriptSortType

How to treat sorting script value

Shape

The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as rectangles and polygons. It can be used to index and query geometries whose coordinates fall in a 2-dimensional planar coordinate system.

Size

Unit-less quantities means that they don’t have a “unit” like “bytes” or “Hertz” or “meter” or “long tonne”.

SourceFilter

Control how the _source field is returned with every hit.

Term

Elasticsearch term value

TermSerializeError

Term conversion error

Time

Whenever durations need to be specified, e.g. for a timeout parameter, the duration must specify the unit, like 2d for 2 days.

TrackTotalHits

Control how the total number of hits should be tracked.

Type Aliases

ChronoTime

DateTime<Utc> type alias