Skip to content

IntOptions

Source code in docs_src/capo_cloudsearch/types/int_options.py
class IntOptions(TypedDict, closed=True):
    default_value: NotRequired["capo_cloudsearch.types.long.Long"]
    """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."""
    source_field: NotRequired["capo_cloudsearch.types.field_name.FieldName"]
    """<p>The name of the source field to map to the field. </p>"""
    facet_enabled: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether facet information can be returned for the field.</p>"""
    search_enabled: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether the contents of the field are searchable.</p>"""
    return_enabled: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether the contents of the field can be returned in the search results.</p>"""
    sort_enabled: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether the field can be used to sort the search results.</p>"""

default_value instance-attribute

default_value: NotRequired[Long]

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.

facet_enabled instance-attribute

facet_enabled: NotRequired[Boolean]

Whether facet information can be returned for the field.

return_enabled instance-attribute

return_enabled: NotRequired[Boolean]

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

search_enabled instance-attribute

search_enabled: NotRequired[Boolean]

Whether the contents of the field are searchable.

sort_enabled instance-attribute

sort_enabled: NotRequired[Boolean]

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

source_field instance-attribute

source_field: NotRequired[FieldName]

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