software.amazon.awscdk.services.kendra

Interface CfnIndex.DocumentMetadataConfigurationProperty

All Known Implementing Classes:

CfnIndex.DocumentMetadataConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndex

public static interface CfnIndex.DocumentMetadataConfigurationProperty

Specifies the properties of a custom index field.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 DocumentMetadataConfigurationProperty documentMetadataConfigurationProperty = DocumentMetadataConfigurationProperty.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .relevance(RelevanceProperty.builder()
                 .duration("duration")
                 .freshness(false)
                 .importance(123)
                 .rankOrder("rankOrder")
                 .valueImportanceItems(List.of(ValueImportanceItemProperty.builder()
                         .key("key")
                         .value(123)
                         .build()))
                 .build())
         .search(SearchProperty.builder()
                 .displayable(false)
                 .facetable(false)
                 .searchable(false)
                 .sortable(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIndex.DocumentMetadataConfigurationProperty.Builder A builder for CfnIndex.DocumentMetadataConfigurationProperty
static class	CfnIndex.DocumentMetadataConfigurationProperty.Jsii$Proxy An implementation for CfnIndex.DocumentMetadataConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnIndex.DocumentMetadataConfigurationProperty.Builder	builder()
java.lang.String	getName() The name of the index field.
default java.lang.Object	getRelevance() Provides manual tuning parameters to determine how the field affects the search results.
default java.lang.Object	getSearch() Provides information about how the field is used during a search.
java.lang.String	getType() The data type of the index field.

Method Detail

getName

java.lang.String getName()

The name of the index field.

getType

java.lang.String getType()

The data type of the index field.

getRelevance

default java.lang.Object getRelevance()

Provides manual tuning parameters to determine how the field affects the search results.

getSearch

default java.lang.Object getSearch()

Provides information about how the field is used during a search.

builder

static CfnIndex.DocumentMetadataConfigurationProperty.Builder builder()

Returns:

a CfnIndex.DocumentMetadataConfigurationProperty.Builder of CfnIndex.DocumentMetadataConfigurationProperty