/*
* 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 DescribeDataSource operation.
///
public partial class DescribeDataSourceResponse : AmazonWebServiceResponse
{
private DataSourceConfiguration _configuration;
private DateTime? _createdAt;
private CustomDocumentEnrichmentConfiguration _customDocumentEnrichmentConfiguration;
private string _description;
private string _errorMessage;
private string _id;
private string _indexId;
private string _languageCode;
private string _name;
private string _roleArn;
private string _schedule;
private DataSourceStatus _status;
private DataSourceType _type;
private DateTime? _updatedAt;
private DataSourceVpcConfiguration _vpcConfiguration;
///
/// Gets and sets the property Configuration.
///
/// Configuration details for the data source connector. This shows how the data source
/// is configured. The configuration options for a data source depend on the data source
/// provider.
///
///
public DataSourceConfiguration Configuration
{
get { return this._configuration; }
set { this._configuration = value; }
}
// Check to see if Configuration property is set
internal bool IsSetConfiguration()
{
return this._configuration != null;
}
///
/// Gets and sets the property CreatedAt.
///
/// The Unix timestamp when the data source connector 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 CustomDocumentEnrichmentConfiguration.
///
/// Configuration information for altering document metadata and content during the document
/// ingestion process when you describe a data source.
///
///
///
/// For more information on how to create, modify and delete document metadata, or make
/// other content alterations when you ingest documents into Amazon Kendra, see Customizing
/// document metadata during the ingestion process.
///
///
public CustomDocumentEnrichmentConfiguration CustomDocumentEnrichmentConfiguration
{
get { return this._customDocumentEnrichmentConfiguration; }
set { this._customDocumentEnrichmentConfiguration = value; }
}
// Check to see if CustomDocumentEnrichmentConfiguration property is set
internal bool IsSetCustomDocumentEnrichmentConfiguration()
{
return this._customDocumentEnrichmentConfiguration != null;
}
///
/// Gets and sets the property Description.
///
/// The description for the data source connector.
///
///
[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.
///
/// When the Status
field value is FAILED
, the ErrorMessage
/// field contains a description of the error that caused the data source to fail.
///
///
[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 Id.
///
/// The identifier of the data source connector.
///
///
[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 used with the data source connector.
///
///
[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 all documents in the
/// data source. 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 for the data source connector.
///
///
[AWSProperty(Min=1, Max=1000)]
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 with permission to access the data source
/// and required resources.
///
///
[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 Schedule.
///
/// The schedule for Amazon Kendra to update the index.
///
///
public string Schedule
{
get { return this._schedule; }
set { this._schedule = value; }
}
// Check to see if Schedule property is set
internal bool IsSetSchedule()
{
return this._schedule != null;
}
///
/// Gets and sets the property Status.
///
/// The current status of the data source connector. When the status is ACTIVE
/// the data source is ready to use. When the status is FAILED
, the ErrorMessage
/// field contains the reason that the data source failed.
///
///
public DataSourceStatus 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 Type.
///
/// The type of the data source. For example, SHAREPOINT
.
///
///
public DataSourceType Type
{
get { return this._type; }
set { this._type = value; }
}
// Check to see if Type property is set
internal bool IsSetType()
{
return this._type != null;
}
///
/// Gets and sets the property UpdatedAt.
///
/// The Unix timestamp when the data source connector 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;
}
///
/// Gets and sets the property VpcConfiguration.
///
/// Configuration information for an Amazon Virtual Private Cloud to connect to your data
/// source. For more information, see Configuring
/// a VPC.
///
///
public DataSourceVpcConfiguration VpcConfiguration
{
get { return this._vpcConfiguration; }
set { this._vpcConfiguration = value; }
}
// Check to see if VpcConfiguration property is set
internal bool IsSetVpcConfiguration()
{
return this._vpcConfiguration != null;
}
}
}