/*
* Copyright 2018-2023 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDataSourceResult extends com.amazonaws.AmazonWebServiceResult
* The identifier of the data source connector.
*
* The identifier of the index used with the data source connector.
*
* The name for the data source connector.
*
* The type of the data source. For example,
* 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.
*
* Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more
* information, see Configuring a
* VPC.
*
* The Unix timestamp when the data source connector was created.
*
* The Unix timestamp when the data source connector was last updated.
*
* The description for the data source connector.
*
* The current status of the data source connector. When the status is
* The schedule for Amazon Kendra to update the index.
*
* The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
*
* When the
* 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.
*
* 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.
*
* The identifier of the data source connector.
*
* The identifier of the data source connector.
*
* The identifier of the data source connector.
*
* The identifier of the index used with the data source connector.
*
* The identifier of the index used with the data source connector.
*
* The identifier of the index used with the data source connector.
*
* The name for the data source connector.
*
* The name for the data source connector.
*
* The name for the data source connector.
*
* The type of the data source. For example,
* The type of the data source. For example,
* The type of the data source. For example,
* The type of the data source. For example,
* 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.
*
* 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.
*
* 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.
*
* Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more
* information, see Configuring a
* VPC.
*
* Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more
* information, see Configuring a
* VPC.
*
* Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more
* information, see Configuring a
* VPC.
*
* The Unix timestamp when the data source connector was created.
*
* The Unix timestamp when the data source connector was created.
*
* The Unix timestamp when the data source connector was created.
*
* The Unix timestamp when the data source connector was last updated.
*
* The Unix timestamp when the data source connector was last updated.
*
* The Unix timestamp when the data source connector was last updated.
*
* The description for the data source connector.
*
* The description for the data source connector.
*
* The description for the data source connector.
*
* The current status of the data source connector. When the status is
* The current status of the data source connector. When the status is
* The current status of the data source connector. When the status is
* The current status of the data source connector. When the status is
* The schedule for Amazon Kendra to update the index.
*
* The schedule for Amazon Kendra to update the index.
*
* The schedule for Amazon Kendra to update the index.
*
* The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
*
* The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
*
* The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
*
* When the
* When the
* When the
* 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.
*
* 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.
*
* 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.
*
* 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.
* SHAREPOINT
.
* ACTIVE
the data source is ready
* to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the
* data source failed.
* Status
field value is FAILED
, the ErrorMessage
field contains a
* description of the error that caused the data source to fail.
* SHAREPOINT
.
* SHAREPOINT
.
* @see DataSourceType
*/
public void setType(String type) {
this.type = type;
}
/**
* SHAREPOINT
.
* SHAREPOINT
.
* @see DataSourceType
*/
public String getType() {
return this.type;
}
/**
* SHAREPOINT
.
* SHAREPOINT
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSourceType
*/
public DescribeDataSourceResult withType(String type) {
setType(type);
return this;
}
/**
* SHAREPOINT
.
* SHAREPOINT
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSourceType
*/
public DescribeDataSourceResult withType(DataSourceType type) {
this.type = type.toString();
return this;
}
/**
* ACTIVE
the data source is ready
* to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the
* data source failed.
* ACTIVE
the data source is
* ready to use. When the status is FAILED
, the ErrorMessage
field contains the
* reason that the data source failed.
* @see DataSourceStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
* ACTIVE
the data source is ready
* to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the
* data source failed.
* ACTIVE
the data source
* is ready to use. When the status is FAILED
, the ErrorMessage
field contains the
* reason that the data source failed.
* @see DataSourceStatus
*/
public String getStatus() {
return this.status;
}
/**
* ACTIVE
the data source is ready
* to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the
* data source failed.
* ACTIVE
the data source is
* ready to use. When the status is FAILED
, the ErrorMessage
field contains the
* reason that the data source failed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSourceStatus
*/
public DescribeDataSourceResult withStatus(String status) {
setStatus(status);
return this;
}
/**
* ACTIVE
the data source is ready
* to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the
* data source failed.
* ACTIVE
the data source is
* ready to use. When the status is FAILED
, the ErrorMessage
field contains the
* reason that the data source failed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSourceStatus
*/
public DescribeDataSourceResult withStatus(DataSourceStatus status) {
this.status = status.toString();
return this;
}
/**
* Status
field value is FAILED
, the ErrorMessage
field contains a
* description of the error that caused the data source to fail.
* Status
field value is FAILED
, the ErrorMessage
field
* contains a description of the error that caused the data source to fail.
*/
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
/**
* Status
field value is FAILED
, the ErrorMessage
field contains a
* description of the error that caused the data source to fail.
* Status
field value is FAILED
, the ErrorMessage
field
* contains a description of the error that caused the data source to fail.
*/
public String getErrorMessage() {
return this.errorMessage;
}
/**
* Status
field value is FAILED
, the ErrorMessage
field contains a
* description of the error that caused the data source to fail.
* Status
field value is FAILED
, the ErrorMessage
field
* contains a description of the error that caused the data source to fail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDataSourceResult withErrorMessage(String errorMessage) {
setErrorMessage(errorMessage);
return this;
}
/**
*
* 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 void setCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration) { this.customDocumentEnrichmentConfiguration = 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. *
* * @return 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 getCustomDocumentEnrichmentConfiguration() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDataSourceResult withCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration) { setCustomDocumentEnrichmentConfiguration(customDocumentEnrichmentConfiguration); 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 (getId() != null) sb.append("Id: ").append(getId()).append(","); if (getIndexId() != null) sb.append("IndexId: ").append(getIndexId()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getType() != null) sb.append("Type: ").append(getType()).append(","); if (getConfiguration() != null) sb.append("Configuration: ").append(getConfiguration()).append(","); if (getVpcConfiguration() != null) sb.append("VpcConfiguration: ").append(getVpcConfiguration()).append(","); if (getCreatedAt() != null) sb.append("CreatedAt: ").append(getCreatedAt()).append(","); if (getUpdatedAt() != null) sb.append("UpdatedAt: ").append(getUpdatedAt()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getSchedule() != null) sb.append("Schedule: ").append(getSchedule()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getErrorMessage() != null) sb.append("ErrorMessage: ").append(getErrorMessage()).append(","); if (getLanguageCode() != null) sb.append("LanguageCode: ").append(getLanguageCode()).append(","); if (getCustomDocumentEnrichmentConfiguration() != null) sb.append("CustomDocumentEnrichmentConfiguration: ").append(getCustomDocumentEnrichmentConfiguration()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeDataSourceResult == false) return false; DescribeDataSourceResult other = (DescribeDataSourceResult) obj; if (other.getId() == null ^ this.getId() == null) return false; if (other.getId() != null && other.getId().equals(this.getId()) == false) return false; 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.getType() == null ^ this.getType() == null) return false; if (other.getType() != null && other.getType().equals(this.getType()) == false) return false; if (other.getConfiguration() == null ^ this.getConfiguration() == null) return false; if (other.getConfiguration() != null && other.getConfiguration().equals(this.getConfiguration()) == false) return false; if (other.getVpcConfiguration() == null ^ this.getVpcConfiguration() == null) return false; if (other.getVpcConfiguration() != null && other.getVpcConfiguration().equals(this.getVpcConfiguration()) == false) return false; if (other.getCreatedAt() == null ^ this.getCreatedAt() == null) return false; if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false) return false; if (other.getUpdatedAt() == null ^ this.getUpdatedAt() == null) return false; if (other.getUpdatedAt() != null && other.getUpdatedAt().equals(this.getUpdatedAt()) == 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.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getSchedule() == null ^ this.getSchedule() == null) return false; if (other.getSchedule() != null && other.getSchedule().equals(this.getSchedule()) == 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.getErrorMessage() == null ^ this.getErrorMessage() == null) return false; if (other.getErrorMessage() != null && other.getErrorMessage().equals(this.getErrorMessage()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; if (other.getCustomDocumentEnrichmentConfiguration() == null ^ this.getCustomDocumentEnrichmentConfiguration() == null) return false; if (other.getCustomDocumentEnrichmentConfiguration() != null && other.getCustomDocumentEnrichmentConfiguration().equals(this.getCustomDocumentEnrichmentConfiguration()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode()); hashCode = prime * hashCode + ((getIndexId() == null) ? 0 : getIndexId().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode()); hashCode = prime * hashCode + ((getConfiguration() == null) ? 0 : getConfiguration().hashCode()); hashCode = prime * hashCode + ((getVpcConfiguration() == null) ? 0 : getVpcConfiguration().hashCode()); hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode()); hashCode = prime * hashCode + ((getUpdatedAt() == null) ? 0 : getUpdatedAt().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getSchedule() == null) ? 0 : getSchedule().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getErrorMessage() == null) ? 0 : getErrorMessage().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getCustomDocumentEnrichmentConfiguration() == null) ? 0 : getCustomDocumentEnrichmentConfiguration().hashCode()); return hashCode; } @Override public DescribeDataSourceResult clone() { try { return (DescribeDataSourceResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }