Skip to content

IndexField

Used by
Source code in docs_src/capo_cloudsearch/types/index_field.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class IndexField(TypedDict, closed=True):
    index_field_name: "capo_cloudsearch.types.dynamic_field_name.DynamicFieldName"
    """<p>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. </p> <p>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. </p> <p>The name <code>score</code> is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <code>_id</code>. </p>"""
    index_field_type: "capo_cloudsearch.types.index_field_type.IndexFieldType"
    int_options: NotRequired["capo_cloudsearch.types.int_options.IntOptions"]
    double_options: NotRequired["capo_cloudsearch.types.double_options.DoubleOptions"]
    literal_options: NotRequired[
        "capo_cloudsearch.types.literal_options.LiteralOptions"
    ]
    text_options: NotRequired["capo_cloudsearch.types.text_options.TextOptions"]
    date_options: NotRequired["capo_cloudsearch.types.date_options.DateOptions"]
    lat_lon_options: NotRequired["capo_cloudsearch.types.lat_lon_options.LatLonOptions"]
    int_array_options: NotRequired[
        "capo_cloudsearch.types.int_array_options.IntArrayOptions"
    ]
    double_array_options: NotRequired[
        "capo_cloudsearch.types.double_array_options.DoubleArrayOptions"
    ]
    literal_array_options: NotRequired[
        "capo_cloudsearch.types.literal_array_options.LiteralArrayOptions"
    ]
    text_array_options: NotRequired[
        "capo_cloudsearch.types.text_array_options.TextArrayOptions"
    ]
    date_array_options: NotRequired[
        "capo_cloudsearch.types.date_array_options.DateArrayOptions"
    ]

date_array_options instance-attribute 

date_array_options: NotRequired[DateArrayOptions]

date_options instance-attribute 

date_options: NotRequired[DateOptions]

double_array_options instance-attribute 

double_array_options: NotRequired[DoubleArrayOptions]

double_options instance-attribute 

double_options: NotRequired[DoubleOptions]

index_field_name instance-attribute 

index_field_name: DynamicFieldName

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.

index_field_type instance-attribute 

index_field_type: IndexFieldType

int_array_options instance-attribute 

int_array_options: NotRequired[IntArrayOptions]

int_options instance-attribute 

int_options: NotRequired[IntOptions]

lat_lon_options instance-attribute 

lat_lon_options: NotRequired[LatLonOptions]

literal_array_options instance-attribute 

literal_array_options: NotRequired[LiteralArrayOptions]

literal_options instance-attribute 

literal_options: NotRequired[LiteralOptions]

text_array_options instance-attribute 

text_array_options: NotRequired[TextArrayOptions]

text_options instance-attribute 

text_options: NotRequired[TextOptions]