commonMain.aws.sdk.kotlin.services.qbusiness.model.RetrieverConfiguration.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.qbusiness.model



/**
 * Provides information on how the retriever used for your Amazon Q Business application is configured.
 */
public sealed class RetrieverConfiguration {
    /**
     * Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
     */
    public data class KendraIndexConfiguration(val value: aws.sdk.kotlin.services.qbusiness.model.KendraIndexConfiguration) : aws.sdk.kotlin.services.qbusiness.model.RetrieverConfiguration() {
    }

    /**
     * Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
     */
    public data class NativeIndexConfiguration(val value: aws.sdk.kotlin.services.qbusiness.model.NativeIndexConfiguration) : aws.sdk.kotlin.services.qbusiness.model.RetrieverConfiguration() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.qbusiness.model.RetrieverConfiguration() {
    }

    /**
     * Casts this [RetrieverConfiguration] as a [KendraIndexConfiguration] and retrieves its [aws.sdk.kotlin.services.qbusiness.model.KendraIndexConfiguration] value. Throws an exception if the [RetrieverConfiguration] is not a
     * [KendraIndexConfiguration].
     */
    public fun asKendraIndexConfiguration(): aws.sdk.kotlin.services.qbusiness.model.KendraIndexConfiguration = (this as RetrieverConfiguration.KendraIndexConfiguration).value

    /**
     * Casts this [RetrieverConfiguration] as a [KendraIndexConfiguration] and retrieves its [aws.sdk.kotlin.services.qbusiness.model.KendraIndexConfiguration] value. Returns null if the [RetrieverConfiguration] is not a [KendraIndexConfiguration].
     */
    public fun asKendraIndexConfigurationOrNull(): aws.sdk.kotlin.services.qbusiness.model.KendraIndexConfiguration? = (this as? RetrieverConfiguration.KendraIndexConfiguration)?.value

    /**
     * Casts this [RetrieverConfiguration] as a [NativeIndexConfiguration] and retrieves its [aws.sdk.kotlin.services.qbusiness.model.NativeIndexConfiguration] value. Throws an exception if the [RetrieverConfiguration] is not a
     * [NativeIndexConfiguration].
     */
    public fun asNativeIndexConfiguration(): aws.sdk.kotlin.services.qbusiness.model.NativeIndexConfiguration = (this as RetrieverConfiguration.NativeIndexConfiguration).value

    /**
     * Casts this [RetrieverConfiguration] as a [NativeIndexConfiguration] and retrieves its [aws.sdk.kotlin.services.qbusiness.model.NativeIndexConfiguration] value. Returns null if the [RetrieverConfiguration] is not a [NativeIndexConfiguration].
     */
    public fun asNativeIndexConfigurationOrNull(): aws.sdk.kotlin.services.qbusiness.model.NativeIndexConfiguration? = (this as? RetrieverConfiguration.NativeIndexConfiguration)?.value
}