com.pulumi.aws.kendra.kotlin.inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.57.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.aws.kendra.kotlin.inputs

import com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 *
 * @property displayable Determines whether the field is returned in the query response. The default is `true`.
 * @property facetable Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is `false`.
 * @property searchable Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for `string` fields and `false` for `number` and `date` fields.
 * @property sortable Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is `false`.
 */
public data class IndexDocumentMetadataConfigurationUpdateSearchArgs(
    public val displayable: Output? = null,
    public val facetable: Output? = null,
    public val searchable: Output? = null,
    public val sortable: Output? = null,
) :
    ConvertibleToJava {
    override fun toJava(): com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs =
        com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
            .displayable(displayable?.applyValue({ args0 -> args0 }))
            .facetable(facetable?.applyValue({ args0 -> args0 }))
            .searchable(searchable?.applyValue({ args0 -> args0 }))
            .sortable(sortable?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [IndexDocumentMetadataConfigurationUpdateSearchArgs].
 */
@PulumiTagMarker
public class IndexDocumentMetadataConfigurationUpdateSearchArgsBuilder internal constructor() {
    private var displayable: Output? = null

    private var facetable: Output? = null

    private var searchable: Output? = null

    private var sortable: Output? = null

    /**
     * @param value Determines whether the field is returned in the query response. The default is `true`.
     */
    @JvmName("cdwaooybknlskpki")
    public suspend fun displayable(`value`: Output) {
        this.displayable = value
    }

    /**
     * @param value Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is `false`.
     */
    @JvmName("lmbikaeyrgamdyah")
    public suspend fun facetable(`value`: Output) {
        this.facetable = value
    }

    /**
     * @param value Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for `string` fields and `false` for `number` and `date` fields.
     */
    @JvmName("icdyhvdejbvilvii")
    public suspend fun searchable(`value`: Output) {
        this.searchable = value
    }

    /**
     * @param value Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is `false`.
     */
    @JvmName("wifefekmjpeagcmd")
    public suspend fun sortable(`value`: Output) {
        this.sortable = value
    }

    /**
     * @param value Determines whether the field is returned in the query response. The default is `true`.
     */
    @JvmName("yjekxtomfcuuqiqv")
    public suspend fun displayable(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.displayable = mapped
    }

    /**
     * @param value Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is `false`.
     */
    @JvmName("vceeujkxdckarjka")
    public suspend fun facetable(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.facetable = mapped
    }

    /**
     * @param value Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for `string` fields and `false` for `number` and `date` fields.
     */
    @JvmName("ydbjiciufbdlhpxo")
    public suspend fun searchable(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.searchable = mapped
    }

    /**
     * @param value Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is `false`.
     */
    @JvmName("sysqjxgnagarrvtq")
    public suspend fun sortable(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.sortable = mapped
    }

    internal fun build(): IndexDocumentMetadataConfigurationUpdateSearchArgs =
        IndexDocumentMetadataConfigurationUpdateSearchArgs(
            displayable = displayable,
            facetable = facetable,
            searchable = searchable,
            sortable = sortable,
        )
}