Struct aws_sdk_kendra::types::DataSourceToIndexFieldMapping

#[non_exhaustive]
pub struct DataSourceToIndexFieldMapping {
    pub data_source_field_name: String,
    pub date_field_format: Option<String>,
    pub index_field_name: String,
}

Maps attributes or field names of the documents synced from the data source to Amazon Kendra index field names. You can set up field mappings for each data source when calling CreateDataSource or UpdateDataSource API. To create custom fields, use the UpdateIndex API to first create an index field and then map to the data source field. For more information, see Mapping data source fields.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data_source_field_name: String

The name of the field in the data source. You must first create the index field using the UpdateIndex API.

date_field_format: Option<String>

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

index_field_name: String

The name of the index field to map to the data source field. The index field type must match the data source field type.

Implementations

impl DataSourceToIndexFieldMapping

pub fn data_source_field_name(&self) -> &str

The name of the field in the data source. You must first create the index field using the UpdateIndex API.

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

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

pub fn index_field_name(&self) -> &str

The name of the index field to map to the data source field. The index field type must match the data source field type.

impl DataSourceToIndexFieldMapping

pub fn builder() -> DataSourceToIndexFieldMappingBuilder

Creates a new builder-style object to manufacture DataSourceToIndexFieldMapping.

Trait Implementations

impl Clone for DataSourceToIndexFieldMapping

fn clone(&self) -> DataSourceToIndexFieldMapping

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataSourceToIndexFieldMapping

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

Formats the value using the given formatter.

impl PartialEq for DataSourceToIndexFieldMapping

fn eq(&self, other: &DataSourceToIndexFieldMapping) -> 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 DataSourceToIndexFieldMapping