All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.aws.kendra.outputs.GetFaqResult Maven / Gradle / Ivy

// *** 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.outputs;

import com.pulumi.aws.kendra.outputs.GetFaqS3Path;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;

@CustomType
public final class GetFaqResult {
    /**
     * @return ARN of the FAQ.
     * 
     */
    private String arn;
    /**
     * @return Unix datetime that the faq was created.
     * 
     */
    private String createdAt;
    /**
     * @return Description of the FAQ.
     * 
     */
    private String description;
    /**
     * @return When the `status` field value is `FAILED`, this contains a message that explains why.
     * 
     */
    private String errorMessage;
    private String faqId;
    /**
     * @return File format used by the input files for the FAQ. Valid Values are `CSV`, `CSV_WITH_HEADER`, `JSON`.
     * 
     */
    private String fileFormat;
    /**
     * @return The provider-assigned unique ID for this managed resource.
     * 
     */
    private String id;
    private String indexId;
    /**
     * @return Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
     * 
     */
    private String languageCode;
    /**
     * @return Name of the FAQ.
     * 
     */
    private String name;
    /**
     * @return ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see [IAM Roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
     * 
     */
    private String roleArn;
    /**
     * @return S3 location of the FAQ input data. Detailed below.
     * 
     */
    private List s3Paths;
    /**
     * @return Status of the FAQ. It is ready to use when the status is ACTIVE.
     * 
     */
    private String status;
    /**
     * @return Metadata that helps organize the FAQs you create.
     * 
     */
    private Map tags;
    /**
     * @return Date and time that the FAQ was last updated.
     * 
     */
    private String updatedAt;

    private GetFaqResult() {}
    /**
     * @return ARN of the FAQ.
     * 
     */
    public String arn() {
        return this.arn;
    }
    /**
     * @return Unix datetime that the faq was created.
     * 
     */
    public String createdAt() {
        return this.createdAt;
    }
    /**
     * @return Description of the FAQ.
     * 
     */
    public String description() {
        return this.description;
    }
    /**
     * @return When the `status` field value is `FAILED`, this contains a message that explains why.
     * 
     */
    public String errorMessage() {
        return this.errorMessage;
    }
    public String faqId() {
        return this.faqId;
    }
    /**
     * @return File format used by the input files for the FAQ. Valid Values are `CSV`, `CSV_WITH_HEADER`, `JSON`.
     * 
     */
    public String fileFormat() {
        return this.fileFormat;
    }
    /**
     * @return The provider-assigned unique ID for this managed resource.
     * 
     */
    public String id() {
        return this.id;
    }
    public String indexId() {
        return this.indexId;
    }
    /**
     * @return Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
     * 
     */
    public String languageCode() {
        return this.languageCode;
    }
    /**
     * @return Name of the FAQ.
     * 
     */
    public String name() {
        return this.name;
    }
    /**
     * @return ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see [IAM Roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
     * 
     */
    public String roleArn() {
        return this.roleArn;
    }
    /**
     * @return S3 location of the FAQ input data. Detailed below.
     * 
     */
    public List s3Paths() {
        return this.s3Paths;
    }
    /**
     * @return Status of the FAQ. It is ready to use when the status is ACTIVE.
     * 
     */
    public String status() {
        return this.status;
    }
    /**
     * @return Metadata that helps organize the FAQs you create.
     * 
     */
    public Map tags() {
        return this.tags;
    }
    /**
     * @return Date and time that the FAQ was last updated.
     * 
     */
    public String updatedAt() {
        return this.updatedAt;
    }

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

    public static Builder builder(GetFaqResult defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private String arn;
        private String createdAt;
        private String description;
        private String errorMessage;
        private String faqId;
        private String fileFormat;
        private String id;
        private String indexId;
        private String languageCode;
        private String name;
        private String roleArn;
        private List s3Paths;
        private String status;
        private Map tags;
        private String updatedAt;
        public Builder() {}
        public Builder(GetFaqResult defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.arn = defaults.arn;
    	      this.createdAt = defaults.createdAt;
    	      this.description = defaults.description;
    	      this.errorMessage = defaults.errorMessage;
    	      this.faqId = defaults.faqId;
    	      this.fileFormat = defaults.fileFormat;
    	      this.id = defaults.id;
    	      this.indexId = defaults.indexId;
    	      this.languageCode = defaults.languageCode;
    	      this.name = defaults.name;
    	      this.roleArn = defaults.roleArn;
    	      this.s3Paths = defaults.s3Paths;
    	      this.status = defaults.status;
    	      this.tags = defaults.tags;
    	      this.updatedAt = defaults.updatedAt;
        }

        @CustomType.Setter
        public Builder arn(String arn) {
            if (arn == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "arn");
            }
            this.arn = arn;
            return this;
        }
        @CustomType.Setter
        public Builder createdAt(String createdAt) {
            if (createdAt == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "createdAt");
            }
            this.createdAt = createdAt;
            return this;
        }
        @CustomType.Setter
        public Builder description(String description) {
            if (description == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "description");
            }
            this.description = description;
            return this;
        }
        @CustomType.Setter
        public Builder errorMessage(String errorMessage) {
            if (errorMessage == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "errorMessage");
            }
            this.errorMessage = errorMessage;
            return this;
        }
        @CustomType.Setter
        public Builder faqId(String faqId) {
            if (faqId == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "faqId");
            }
            this.faqId = faqId;
            return this;
        }
        @CustomType.Setter
        public Builder fileFormat(String fileFormat) {
            if (fileFormat == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "fileFormat");
            }
            this.fileFormat = fileFormat;
            return this;
        }
        @CustomType.Setter
        public Builder id(String id) {
            if (id == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "id");
            }
            this.id = id;
            return this;
        }
        @CustomType.Setter
        public Builder indexId(String indexId) {
            if (indexId == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "indexId");
            }
            this.indexId = indexId;
            return this;
        }
        @CustomType.Setter
        public Builder languageCode(String languageCode) {
            if (languageCode == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "languageCode");
            }
            this.languageCode = languageCode;
            return this;
        }
        @CustomType.Setter
        public Builder name(String name) {
            if (name == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "name");
            }
            this.name = name;
            return this;
        }
        @CustomType.Setter
        public Builder roleArn(String roleArn) {
            if (roleArn == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "roleArn");
            }
            this.roleArn = roleArn;
            return this;
        }
        @CustomType.Setter
        public Builder s3Paths(List s3Paths) {
            if (s3Paths == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "s3Paths");
            }
            this.s3Paths = s3Paths;
            return this;
        }
        public Builder s3Paths(GetFaqS3Path... s3Paths) {
            return s3Paths(List.of(s3Paths));
        }
        @CustomType.Setter
        public Builder status(String status) {
            if (status == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "status");
            }
            this.status = status;
            return this;
        }
        @CustomType.Setter
        public Builder tags(Map tags) {
            if (tags == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "tags");
            }
            this.tags = tags;
            return this;
        }
        @CustomType.Setter
        public Builder updatedAt(String updatedAt) {
            if (updatedAt == null) {
              throw new MissingRequiredPropertyException("GetFaqResult", "updatedAt");
            }
            this.updatedAt = updatedAt;
            return this;
        }
        public GetFaqResult build() {
            final var _resultValue = new GetFaqResult();
            _resultValue.arn = arn;
            _resultValue.createdAt = createdAt;
            _resultValue.description = description;
            _resultValue.errorMessage = errorMessage;
            _resultValue.faqId = faqId;
            _resultValue.fileFormat = fileFormat;
            _resultValue.id = id;
            _resultValue.indexId = indexId;
            _resultValue.languageCode = languageCode;
            _resultValue.name = name;
            _resultValue.roleArn = roleArn;
            _resultValue.s3Paths = s3Paths;
            _resultValue.status = status;
            _resultValue.tags = tags;
            _resultValue.updatedAt = updatedAt;
            return _resultValue;
        }
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy