Skip to content

LiteralOptions

Source code in docs_src/capo_cloudsearch/types/literal_options.py 
15
16
17
18
19
20
21
22
23
24
25
26
class LiteralOptions(TypedDict, closed=True):
    default_value: NotRequired["capo_cloudsearch.types.field_value.FieldValue"]
    """A value to use for the field if the field isn't specified for a document."""
    source_field: NotRequired["capo_cloudsearch.types.field_name.FieldName"]
    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[FieldValue]

A value to use for the field if the field isn't specified for a 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]