Struct aws_sdk_cloudsearch::model::IndexField

#[non_exhaustive]
pub struct IndexField { /* private fields */ }

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

Implementations

impl IndexField

pub fn index_field_name(&self) -> Option<&str>

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.

pub fn index_field_type(&self) -> Option<&IndexFieldType>

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

pub fn int_options(&self) -> Option<&IntOptions>

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

pub fn double_options(&self) -> Option<&DoubleOptions>

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

pub fn literal_options(&self) -> Option<&LiteralOptions>

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

pub fn text_options(&self) -> Option<&TextOptions>

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

pub fn date_options(&self) -> Option<&DateOptions>

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

pub fn lat_lon_options(&self) -> Option<&LatLonOptions>

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

pub fn int_array_options(&self) -> Option<&IntArrayOptions>

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

pub fn double_array_options(&self) -> Option<&DoubleArrayOptions>

Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

pub fn literal_array_options(&self) -> Option<&LiteralArrayOptions>

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

pub fn text_array_options(&self) -> Option<&TextArrayOptions>

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

pub fn date_array_options(&self) -> Option<&DateArrayOptions>

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

impl IndexField

pub fn builder() -> Builder

Creates a new builder-style object to manufacture IndexField.

Examples found in repository

src/xml_deser.rs (line 2520)

pub fn deser_structure_crate_model_index_field(
    decoder: &mut aws_smithy_xml::decode::ScopedDecoder,
) -> Result<crate::model::IndexField, aws_smithy_xml::decode::XmlDecodeError> {
    #[allow(unused_mut)]
    let mut builder = crate::model::IndexField::builder();
    while let Some(mut tag) = decoder.next_tag() {
        match tag.start_el() {
            s if s.matches("IndexFieldName") /* IndexFieldName com.amazonaws.cloudsearch#IndexField$IndexFieldName */ =>  {
                let var_85 =
                    Some(
                        Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
                            aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            .into()
                        )
                        ?
                    )
                ;
                builder = builder.set_index_field_name(var_85);
            }
            ,
            s if s.matches("IndexFieldType") /* IndexFieldType com.amazonaws.cloudsearch#IndexField$IndexFieldType */ =>  {
                let var_86 =
                    Some(
                        Result::<crate::model::IndexFieldType, aws_smithy_xml::decode::XmlDecodeError>::Ok(
                            crate::model::IndexFieldType::from(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                        )
                        ?
                    )
                ;
                builder = builder.set_index_field_type(var_86);
            }
            ,
            s if s.matches("IntOptions") /* IntOptions com.amazonaws.cloudsearch#IndexField$IntOptions */ =>  {
                let var_87 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_int_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_int_options(var_87);
            }
            ,
            s if s.matches("DoubleOptions") /* DoubleOptions com.amazonaws.cloudsearch#IndexField$DoubleOptions */ =>  {
                let var_88 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_double_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_double_options(var_88);
            }
            ,
            s if s.matches("LiteralOptions") /* LiteralOptions com.amazonaws.cloudsearch#IndexField$LiteralOptions */ =>  {
                let var_89 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_literal_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_literal_options(var_89);
            }
            ,
            s if s.matches("TextOptions") /* TextOptions com.amazonaws.cloudsearch#IndexField$TextOptions */ =>  {
                let var_90 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_text_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_text_options(var_90);
            }
            ,
            s if s.matches("DateOptions") /* DateOptions com.amazonaws.cloudsearch#IndexField$DateOptions */ =>  {
                let var_91 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_date_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_date_options(var_91);
            }
            ,
            s if s.matches("LatLonOptions") /* LatLonOptions com.amazonaws.cloudsearch#IndexField$LatLonOptions */ =>  {
                let var_92 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_lat_lon_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_lat_lon_options(var_92);
            }
            ,
            s if s.matches("IntArrayOptions") /* IntArrayOptions com.amazonaws.cloudsearch#IndexField$IntArrayOptions */ =>  {
                let var_93 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_int_array_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_int_array_options(var_93);
            }
            ,
            s if s.matches("DoubleArrayOptions") /* DoubleArrayOptions com.amazonaws.cloudsearch#IndexField$DoubleArrayOptions */ =>  {
                let var_94 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_double_array_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_double_array_options(var_94);
            }
            ,
            s if s.matches("LiteralArrayOptions") /* LiteralArrayOptions com.amazonaws.cloudsearch#IndexField$LiteralArrayOptions */ =>  {
                let var_95 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_literal_array_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_literal_array_options(var_95);
            }
            ,
            s if s.matches("TextArrayOptions") /* TextArrayOptions com.amazonaws.cloudsearch#IndexField$TextArrayOptions */ =>  {
                let var_96 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_text_array_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_text_array_options(var_96);
            }
            ,
            s if s.matches("DateArrayOptions") /* DateArrayOptions com.amazonaws.cloudsearch#IndexField$DateArrayOptions */ =>  {
                let var_97 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_date_array_options(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_date_array_options(var_97);
            }
            ,
            _ => {}
        }
    }
    Ok(builder.build())
}

Trait Implementations

impl Clone for IndexField

fn clone(&self) -> IndexField

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexField

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<IndexField> for IndexField

fn eq(&self, other: &IndexField) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IndexField