/*
* 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 DescribeQuerySuggestionsBlockList operation.
///
public partial class DescribeQuerySuggestionsBlockListResponse : AmazonWebServiceResponse
{
private DateTime? _createdAt;
private string _description;
private string _errorMessage;
private long? _fileSizeBytes;
private string _id;
private string _indexId;
private int? _itemCount;
private string _name;
private string _roleArn;
private S3Path _sourceS3Path;
private QuerySuggestionsBlockListStatus _status;
private DateTime? _updatedAt;
///
/// Gets and sets the property CreatedAt.
///
/// The Unix timestamp when a block list for query suggestions 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 for the block list.
///
///
[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.
///
/// The error message containing details if there are issues processing the block list.
///
///
[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 FileSizeBytes.
///
/// The current size of the block list text file in S3.
///
///
public long FileSizeBytes
{
get { return this._fileSizeBytes.GetValueOrDefault(); }
set { this._fileSizeBytes = value; }
}
// Check to see if FileSizeBytes property is set
internal bool IsSetFileSizeBytes()
{
return this._fileSizeBytes.HasValue;
}
///
/// Gets and sets the property Id.
///
/// The identifier of the block list.
///
///
[AWSProperty(Min=36, Max=36)]
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 block list.
///
///
[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 ItemCount.
///
/// The current number of valid, non-empty words or phrases in the block list text file.
///
///
public int ItemCount
{
get { return this._itemCount.GetValueOrDefault(); }
set { this._itemCount = value; }
}
// Check to see if ItemCount property is set
internal bool IsSetItemCount()
{
return this._itemCount.HasValue;
}
///
/// Gets and sets the property Name.
///
/// The name of the block list.
///
///
[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 IAM (Identity and Access Management) role used by Amazon Kendra to access the
/// block list text file in S3.
///
///
///
/// The role needs S3 read permissions to your file in S3 and needs to give STS (Security
/// Token Service) assume role permissions to Amazon Kendra.
///
///
[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 SourceS3Path.
///
/// Shows the current S3 path to your block list text file in your S3 bucket.
///
///
///
/// Each block word or phrase should be on a separate line in a text file.
///
///
///
/// For information on the current quota limits for block lists, see Quotas
/// for Amazon Kendra.
///
///
public S3Path SourceS3Path
{
get { return this._sourceS3Path; }
set { this._sourceS3Path = value; }
}
// Check to see if SourceS3Path property is set
internal bool IsSetSourceS3Path()
{
return this._sourceS3Path != null;
}
///
/// Gets and sets the property Status.
///
/// The current status of the block list. When the value is ACTIVE
, the block
/// list is ready for use.
///
///
public QuerySuggestionsBlockListStatus 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 a block list for query suggestions 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;
}
}
}