com.amazonaws.services.kendra.model.CreateFaqRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateFaqRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the index for the FAQ.
*
*/
private String indexId;
/**
*
* A name for the FAQ.
*
*/
private String name;
/**
*
* A description for the FAQ.
*
*/
private String description;
/**
*
* The path to the FAQ file in S3.
*
*/
private S3Path s3Path;
/**
*
* The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For
* more information, see IAM access roles for
* Amazon Kendra.
*
*/
private String roleArn;
/**
*
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and
* to control access to resources.
*
*/
private java.util.List tags;
/**
*
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs
* attributes in a header, and a JSON format that includes custom attributes.
*
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding
* questions and answers.
*
*/
private String fileFormat;
/**
*
* A token that you provide to identify the request to create a FAQ. Multiple calls to the
* CreateFaqRequest API with the same client token will create only one FAQ.
*
*/
private String clientToken;
/**
*
* The code for a language. This allows you to support a language for the FAQ document. English is supported by
* default. For more information on supported languages, including their codes, see Adding documents in languages other
* than English.
*
*/
private String languageCode;
/**
*
* The identifier of the index for the FAQ.
*
*
* @param indexId
* The identifier of the index for the FAQ.
*/
public void setIndexId(String indexId) {
this.indexId = indexId;
}
/**
*
* The identifier of the index for the FAQ.
*
*
* @return The identifier of the index for the FAQ.
*/
public String getIndexId() {
return this.indexId;
}
/**
*
* The identifier of the index for the FAQ.
*
*
* @param indexId
* The identifier of the index for the FAQ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withIndexId(String indexId) {
setIndexId(indexId);
return this;
}
/**
*
* A name for the FAQ.
*
*
* @param name
* A name for the FAQ.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A name for the FAQ.
*
*
* @return A name for the FAQ.
*/
public String getName() {
return this.name;
}
/**
*
* A name for the FAQ.
*
*
* @param name
* A name for the FAQ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A description for the FAQ.
*
*
* @param description
* A description for the FAQ.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description for the FAQ.
*
*
* @return A description for the FAQ.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description for the FAQ.
*
*
* @param description
* A description for the FAQ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The path to the FAQ file in S3.
*
*
* @param s3Path
* The path to the FAQ file in S3.
*/
public void setS3Path(S3Path s3Path) {
this.s3Path = s3Path;
}
/**
*
* The path to the FAQ file in S3.
*
*
* @return The path to the FAQ file in S3.
*/
public S3Path getS3Path() {
return this.s3Path;
}
/**
*
* The path to the FAQ file in S3.
*
*
* @param s3Path
* The path to the FAQ file in S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withS3Path(S3Path s3Path) {
setS3Path(s3Path);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For
* more information, see IAM access roles for
* Amazon Kendra.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the
* FAQs. For more information, see IAM
* access roles for Amazon Kendra.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For
* more information, see IAM access roles for
* Amazon Kendra.
*
*
* @return The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the
* FAQs. For more information, see IAM
* access roles for Amazon Kendra.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For
* more information, see IAM access roles for
* Amazon Kendra.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the
* FAQs. For more information, see IAM
* access roles for Amazon Kendra.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and
* to control access to resources.
*
*
* @return A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your
* resources and to control access to resources.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and
* to control access to resources.
*
*
* @param tags
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your
* resources and to control access to resources.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and
* to control access to resources.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your
* resources and to control access to resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and
* to control access to resources.
*
*
* @param tags
* A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your
* resources and to control access to resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs
* attributes in a header, and a JSON format that includes custom attributes.
*
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding
* questions and answers.
*
*
* @param fileFormat
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes
* customs attributes in a header, and a JSON format that includes custom attributes.
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding questions and answers.
* @see FaqFileFormat
*/
public void setFileFormat(String fileFormat) {
this.fileFormat = fileFormat;
}
/**
*
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs
* attributes in a header, and a JSON format that includes custom attributes.
*
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding
* questions and answers.
*
*
* @return The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes
* customs attributes in a header, and a JSON format that includes custom attributes.
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the
* S3Path parameter.
*
*
* For more information, see Adding questions and
* answers.
* @see FaqFileFormat
*/
public String getFileFormat() {
return this.fileFormat;
}
/**
*
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs
* attributes in a header, and a JSON format that includes custom attributes.
*
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding
* questions and answers.
*
*
* @param fileFormat
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes
* customs attributes in a header, and a JSON format that includes custom attributes.
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding questions and answers.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FaqFileFormat
*/
public CreateFaqRequest withFileFormat(String fileFormat) {
setFileFormat(fileFormat);
return this;
}
/**
*
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs
* attributes in a header, and a JSON format that includes custom attributes.
*
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding
* questions and answers.
*
*
* @param fileFormat
* The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes
* customs attributes in a header, and a JSON format that includes custom attributes.
*
* The default format is CSV.
*
*
* The format must match the format of the file stored in the S3 bucket identified in the S3Path
* parameter.
*
*
* For more information, see Adding questions and answers.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FaqFileFormat
*/
public CreateFaqRequest withFileFormat(FaqFileFormat fileFormat) {
this.fileFormat = fileFormat.toString();
return this;
}
/**
*
* A token that you provide to identify the request to create a FAQ. Multiple calls to the
* CreateFaqRequest API with the same client token will create only one FAQ.
*
*
* @param clientToken
* A token that you provide to identify the request to create a FAQ. Multiple calls to the
* CreateFaqRequest API with the same client token will create only one FAQ.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A token that you provide to identify the request to create a FAQ. Multiple calls to the
* CreateFaqRequest API with the same client token will create only one FAQ.
*
*
* @return A token that you provide to identify the request to create a FAQ. Multiple calls to the
* CreateFaqRequest API with the same client token will create only one FAQ.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A token that you provide to identify the request to create a FAQ. Multiple calls to the
* CreateFaqRequest API with the same client token will create only one FAQ.
*
*
* @param clientToken
* A token that you provide to identify the request to create a FAQ. Multiple calls to the
* CreateFaqRequest API with the same client token will create only one FAQ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The code for a language. This allows you to support a language for the FAQ document. English is supported by
* default. For more information on supported languages, including their codes, see Adding documents in languages other
* than English.
*
*
* @param languageCode
* The code for a language. This allows you to support a language for the FAQ document. English is supported
* by default. For more information on supported languages, including their codes, see Adding documents in languages
* other than English.
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
*
* The code for a language. This allows you to support a language for the FAQ document. English is supported by
* default. For more information on supported languages, including their codes, see Adding documents in languages other
* than English.
*
*
* @return The code for a language. This allows you to support a language for the FAQ document. English is supported
* by default. For more information on supported languages, including their codes, see Adding documents in
* languages other than English.
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
*
* The code for a language. This allows you to support a language for the FAQ document. English is supported by
* default. For more information on supported languages, including their codes, see Adding documents in languages other
* than English.
*
*
* @param languageCode
* The code for a language. This allows you to support a language for the FAQ document. English is supported
* by default. For more information on supported languages, including their codes, see Adding documents in languages
* other than English.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFaqRequest withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getIndexId() != null)
sb.append("IndexId: ").append(getIndexId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getS3Path() != null)
sb.append("S3Path: ").append(getS3Path()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getFileFormat() != null)
sb.append("FileFormat: ").append(getFileFormat()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateFaqRequest == false)
return false;
CreateFaqRequest other = (CreateFaqRequest) obj;
if (other.getIndexId() == null ^ this.getIndexId() == null)
return false;
if (other.getIndexId() != null && other.getIndexId().equals(this.getIndexId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getS3Path() == null ^ this.getS3Path() == null)
return false;
if (other.getS3Path() != null && other.getS3Path().equals(this.getS3Path()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getFileFormat() == null ^ this.getFileFormat() == null)
return false;
if (other.getFileFormat() != null && other.getFileFormat().equals(this.getFileFormat()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIndexId() == null) ? 0 : getIndexId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getS3Path() == null) ? 0 : getS3Path().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getFileFormat() == null) ? 0 : getFileFormat().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
return hashCode;
}
@Override
public CreateFaqRequest clone() {
return (CreateFaqRequest) super.clone();
}
}