/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the kendra-2019-02-03.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Kendra.Model
{
///
/// This is the response object from the DescribeFaq operation.
///
public partial class DescribeFaqResponse : AmazonWebServiceResponse
{
private DateTime? _createdAt;
private string _description;
private string _errorMessage;
private FaqFileFormat _fileFormat;
private string _id;
private string _indexId;
private string _languageCode;
private string _name;
private string _roleArn;
private S3Path _s3Path;
private FaqStatus _status;
private DateTime? _updatedAt;
///
/// Gets and sets the property CreatedAt.
///
/// The Unix timestamp when the FAQ was created.
///
///
public DateTime CreatedAt
{
get { return this._createdAt.GetValueOrDefault(); }
set { this._createdAt = value; }
}
// Check to see if CreatedAt property is set
internal bool IsSetCreatedAt()
{
return this._createdAt.HasValue;
}
///
/// Gets and sets the property Description.
///
/// The description of the FAQ that you provided when it was created.
///
///
[AWSProperty(Min=0, Max=1000)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property ErrorMessage.
///
/// If the Status
field is FAILED
, the ErrorMessage
/// field contains the reason why the FAQ failed.
///
///
[AWSProperty(Min=1, Max=2048)]
public string ErrorMessage
{
get { return this._errorMessage; }
set { this._errorMessage = value; }
}
// Check to see if ErrorMessage property is set
internal bool IsSetErrorMessage()
{
return this._errorMessage != null;
}
///
/// Gets and sets the property FileFormat.
///
/// The file format used by the input files for the FAQ.
///
///
public FaqFileFormat FileFormat
{
get { return this._fileFormat; }
set { this._fileFormat = value; }
}
// Check to see if FileFormat property is set
internal bool IsSetFileFormat()
{
return this._fileFormat != null;
}
///
/// Gets and sets the property Id.
///
/// The identifier of the FAQ.
///
///
[AWSProperty(Min=1, Max=100)]
public string Id
{
get { return this._id; }
set { this._id = value; }
}
// Check to see if Id property is set
internal bool IsSetId()
{
return this._id != null;
}
///
/// Gets and sets the property IndexId.
///
/// The identifier of the index for the FAQ.
///
///
[AWSProperty(Min=36, Max=36)]
public string IndexId
{
get { return this._indexId; }
set { this._indexId = value; }
}
// Check to see if IndexId property is set
internal bool IsSetIndexId()
{
return this._indexId != null;
}
///
/// Gets and sets the property LanguageCode.
///
/// The code for a language. This shows a supported 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.
///
///
[AWSProperty(Min=2, Max=10)]
public string LanguageCode
{
get { return this._languageCode; }
set { this._languageCode = value; }
}
// Check to see if LanguageCode property is set
internal bool IsSetLanguageCode()
{
return this._languageCode != null;
}
///
/// Gets and sets the property Name.
///
/// The name that you gave the FAQ when it was created.
///
///
[AWSProperty(Min=1, Max=100)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property RoleArn.
///
/// The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing
/// the input files for the FAQ.
///
///
[AWSProperty(Min=0, Max=1284)]
public string RoleArn
{
get { return this._roleArn; }
set { this._roleArn = value; }
}
// Check to see if RoleArn property is set
internal bool IsSetRoleArn()
{
return this._roleArn != null;
}
///
/// Gets and sets the property S3Path.
///
public S3Path S3Path
{
get { return this._s3Path; }
set { this._s3Path = value; }
}
// Check to see if S3Path property is set
internal bool IsSetS3Path()
{
return this._s3Path != null;
}
///
/// Gets and sets the property Status.
///
/// The status of the FAQ. It is ready to use when the status is ACTIVE
.
///
///
public FaqStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
///
/// Gets and sets the property UpdatedAt.
///
/// The Unix timestamp when the FAQ was last updated.
///
///
public DateTime UpdatedAt
{
get { return this._updatedAt.GetValueOrDefault(); }
set { this._updatedAt = value; }
}
// Check to see if UpdatedAt property is set
internal bool IsSetUpdatedAt()
{
return this._updatedAt.HasValue;
}
}
}