com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs Maven / Gradle / Ivy

Go to download
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.kendra.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class IndexDocumentMetadataConfigurationUpdateRelevanceArgs extends com.pulumi.resources.ResourceArgs {

    public static final IndexDocumentMetadataConfigurationUpdateRelevanceArgs Empty = new IndexDocumentMetadataConfigurationUpdateRelevanceArgs();

    /**
     * Specifies the time period that the boost applies to. For more information, refer to [Duration](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Duration).
     * 
     */
    @Import(name="duration")
    private @Nullable Output duration;

    /**
     * @return Specifies the time period that the boost applies to. For more information, refer to [Duration](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Duration).
     * 
     */
    public Optional> duration() {
        return Optional.ofNullable(this.duration);
    }

    /**
     * Indicates that this field determines how "fresh" a document is. For more information, refer to [Freshness](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Freshness).
     * 
     */
    @Import(name="freshness")
    private @Nullable Output freshness;

    /**
     * @return Indicates that this field determines how "fresh" a document is. For more information, refer to [Freshness](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Freshness).
     * 
     */
    public Optional> freshness() {
        return Optional.ofNullable(this.freshness);
    }

    /**
     * The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
     * 
     */
    @Import(name="importance")
    private @Nullable Output importance;

    /**
     * @return The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
     * 
     */
    public Optional> importance() {
        return Optional.ofNullable(this.importance);
    }

    /**
     * Determines how values should be interpreted. For more information, refer to [RankOrder](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-RankOrder).
     * 
     */
    @Import(name="rankOrder")
    private @Nullable Output rankOrder;

    /**
     * @return Determines how values should be interpreted. For more information, refer to [RankOrder](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-RankOrder).
     * 
     */
    public Optional> rankOrder() {
        return Optional.ofNullable(this.rankOrder);
    }

    /**
     * A list of values that should be given a different boost when they appear in the result list. For more information, refer to [ValueImportanceMap](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-ValueImportanceMap).
     * 
     */
    @Import(name="valuesImportanceMap")
    private @Nullable Output> valuesImportanceMap;

    /**
     * @return A list of values that should be given a different boost when they appear in the result list. For more information, refer to [ValueImportanceMap](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-ValueImportanceMap).
     * 
     */
    public Optional>> valuesImportanceMap() {
        return Optional.ofNullable(this.valuesImportanceMap);
    }

    private IndexDocumentMetadataConfigurationUpdateRelevanceArgs() {}

    private IndexDocumentMetadataConfigurationUpdateRelevanceArgs(IndexDocumentMetadataConfigurationUpdateRelevanceArgs $) {
        this.duration = $.duration;
        this.freshness = $.freshness;
        this.importance = $.importance;
        this.rankOrder = $.rankOrder;
        this.valuesImportanceMap = $.valuesImportanceMap;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(IndexDocumentMetadataConfigurationUpdateRelevanceArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private IndexDocumentMetadataConfigurationUpdateRelevanceArgs $;

        public Builder() {
            $ = new IndexDocumentMetadataConfigurationUpdateRelevanceArgs();
        }

        public Builder(IndexDocumentMetadataConfigurationUpdateRelevanceArgs defaults) {
            $ = new IndexDocumentMetadataConfigurationUpdateRelevanceArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param duration Specifies the time period that the boost applies to. For more information, refer to [Duration](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Duration).
         * 
         * @return builder
         * 
         */
        public Builder duration(@Nullable Output duration) {
            $.duration = duration;
            return this;
        }

        /**
         * @param duration Specifies the time period that the boost applies to. For more information, refer to [Duration](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Duration).
         * 
         * @return builder
         * 
         */
        public Builder duration(String duration) {
            return duration(Output.of(duration));
        }

        /**
         * @param freshness Indicates that this field determines how "fresh" a document is. For more information, refer to [Freshness](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Freshness).
         * 
         * @return builder
         * 
         */
        public Builder freshness(@Nullable Output freshness) {
            $.freshness = freshness;
            return this;
        }

        /**
         * @param freshness Indicates that this field determines how "fresh" a document is. For more information, refer to [Freshness](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-Freshness).
         * 
         * @return builder
         * 
         */
        public Builder freshness(Boolean freshness) {
            return freshness(Output.of(freshness));
        }

        /**
         * @param importance The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
         * 
         * @return builder
         * 
         */
        public Builder importance(@Nullable Output importance) {
            $.importance = importance;
            return this;
        }

        /**
         * @param importance The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
         * 
         * @return builder
         * 
         */
        public Builder importance(Integer importance) {
            return importance(Output.of(importance));
        }

        /**
         * @param rankOrder Determines how values should be interpreted. For more information, refer to [RankOrder](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-RankOrder).
         * 
         * @return builder
         * 
         */
        public Builder rankOrder(@Nullable Output rankOrder) {
            $.rankOrder = rankOrder;
            return this;
        }

        /**
         * @param rankOrder Determines how values should be interpreted. For more information, refer to [RankOrder](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-RankOrder).
         * 
         * @return builder
         * 
         */
        public Builder rankOrder(String rankOrder) {
            return rankOrder(Output.of(rankOrder));
        }

        /**
         * @param valuesImportanceMap A list of values that should be given a different boost when they appear in the result list. For more information, refer to [ValueImportanceMap](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-ValueImportanceMap).
         * 
         * @return builder
         * 
         */
        public Builder valuesImportanceMap(@Nullable Output> valuesImportanceMap) {
            $.valuesImportanceMap = valuesImportanceMap;
            return this;
        }

        /**
         * @param valuesImportanceMap A list of values that should be given a different boost when they appear in the result list. For more information, refer to [ValueImportanceMap](https://docs.aws.amazon.com/kendra/latest/dg/API_Relevance.html#Kendra-Type-Relevance-ValueImportanceMap).
         * 
         * @return builder
         * 
         */
        public Builder valuesImportanceMap(Map valuesImportanceMap) {
            return valuesImportanceMap(Output.of(valuesImportanceMap));
        }

        public IndexDocumentMetadataConfigurationUpdateRelevanceArgs build() {
            return $;
        }
    }

}