Documentation

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

See: newIntOptions smart constructor.

Create a value of IntOptions 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:IntOptions', intOptions_sourceField - The name of the source field to map to the field.

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

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

$sel:searchEnabled:IntOptions', intOptions_searchEnabled - Whether the contents of the field are searchable.

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

$sel:defaultValue:IntOptions', intOptions_defaultValue - A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

The name of the source field to map to the field.

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

Whether facet information can be returned for the field.

Whether the contents of the field are searchable.

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

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.