DescribeDataSourceResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kendra.model.DescribeDataSourceResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDataSourceResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeDataSourceResult()

Constructors
Constructor and Description
`DescribeDataSourceResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeDataSourceResult`	`clone()`
`boolean`	`equals(Object obj)`
`DataSourceConfiguration`	`getConfiguration()` Describes how the data source is configured.
`Date`	`getCreatedAt()` The Unix timestamp of when the data source was created.
`CustomDocumentEnrichmentConfiguration`	`getCustomDocumentEnrichmentConfiguration()` Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
`String`	`getDescription()` The description of the data source.
`String`	`getErrorMessage()` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source to fail.
`String`	`getId()` The identifier of the data source.
`String`	`getIndexId()` The identifier of the index that contains the data source.
`String`	`getLanguageCode()` The code for a language.
`String`	`getName()` The name that you gave the data source when it was created.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
`String`	`getSchedule()` The schedule for Amazon Kendra to update the index.
`String`	`getStatus()` The current status of the data source.
`String`	`getType()` The type of the data source.
`Date`	`getUpdatedAt()` The Unix timestamp of when the data source was last updated.
`int`	`hashCode()`
`void`	`setConfiguration(DataSourceConfiguration configuration)` Describes how the data source is configured.
`void`	`setCreatedAt(Date createdAt)` The Unix timestamp of when the data source was created.
`void`	`setCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)` Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
`void`	`setDescription(String description)` The description of the data source.
`void`	`setErrorMessage(String errorMessage)` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source to fail.
`void`	`setId(String id)` The identifier of the data source.
`void`	`setIndexId(String indexId)` The identifier of the index that contains the data source.
`void`	`setLanguageCode(String languageCode)` The code for a language.
`void`	`setName(String name)` The name that you gave the data source when it was created.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
`void`	`setSchedule(String schedule)` The schedule for Amazon Kendra to update the index.
`void`	`setStatus(String status)` The current status of the data source.
`void`	`setType(String type)` The type of the data source.
`void`	`setUpdatedAt(Date updatedAt)` The Unix timestamp of when the data source was last updated.
`String`	`toString()` Returns a string representation of this object.
`DescribeDataSourceResult`	`withConfiguration(DataSourceConfiguration configuration)` Describes how the data source is configured.
`DescribeDataSourceResult`	`withCreatedAt(Date createdAt)` The Unix timestamp of when the data source was created.
`DescribeDataSourceResult`	`withCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)` Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
`DescribeDataSourceResult`	`withDescription(String description)` The description of the data source.
`DescribeDataSourceResult`	`withErrorMessage(String errorMessage)` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source to fail.
`DescribeDataSourceResult`	`withId(String id)` The identifier of the data source.
`DescribeDataSourceResult`	`withIndexId(String indexId)` The identifier of the index that contains the data source.
`DescribeDataSourceResult`	`withLanguageCode(String languageCode)` The code for a language.
`DescribeDataSourceResult`	`withName(String name)` The name that you gave the data source when it was created.
`DescribeDataSourceResult`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
`DescribeDataSourceResult`	`withSchedule(String schedule)` The schedule for Amazon Kendra to update the index.
`DescribeDataSourceResult`	`withStatus(DataSourceStatus status)` The current status of the data source.
`DescribeDataSourceResult`	`withStatus(String status)` The current status of the data source.
`DescribeDataSourceResult`	`withType(DataSourceType type)` The type of the data source.
`DescribeDataSourceResult`	`withType(String type)` The type of the data source.
`DescribeDataSourceResult`	`withUpdatedAt(Date updatedAt)` The Unix timestamp of when the data source was last updated.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeDataSourceResult
```
public DescribeDataSourceResult()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the data source.
    
    Parameters:
    
    id - The identifier of the data source.
  - getId
```
public String getId()
```
    The identifier of the data source.
    
    Returns:
    
    The identifier of the data source.
  - withId
```
public DescribeDataSourceResult withId(String id)
```
    The identifier of the data source.
    
    Parameters:
    
    id - The identifier of the data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexId
```
public void setIndexId(String indexId)
```
    The identifier of the index that contains the data source.
    
    Parameters:
    
    indexId - The identifier of the index that contains the data source.
  - getIndexId
```
public String getIndexId()
```
    The identifier of the index that contains the data source.
    
    Returns:
    
    The identifier of the index that contains the data source.
  - withIndexId
```
public DescribeDataSourceResult withIndexId(String indexId)
```
    The identifier of the index that contains the data source.
    
    Parameters:
    
    indexId - The identifier of the index that contains the data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name that you gave the data source when it was created.
    
    Parameters:
    
    name - The name that you gave the data source when it was created.
  - getName
```
public String getName()
```
    The name that you gave the data source when it was created.
    
    Returns:
    
    The name that you gave the data source when it was created.
  - withName
```
public DescribeDataSourceResult withName(String name)
```
    The name that you gave the data source when it was created.
    
    Parameters:
    
    name - The name that you gave the data source when it was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the data source.
    
    Parameters:
    
    type - The type of the data source.
    
    See Also:
    
    DataSourceType
  - getType
```
public String getType()
```
    The type of the data source.
    
    Returns:
    
    The type of the data source.
    
    See Also:
    
    DataSourceType
  - withType
```
public DescribeDataSourceResult withType(String type)
```
    The type of the data source.
    
    Parameters:
    
    type - The type of the data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceType
  - withType
```
public DescribeDataSourceResult withType(DataSourceType type)
```
    The type of the data source.
    
    Parameters:
    
    type - The type of the data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceType
  - setConfiguration
```
public void setConfiguration(DataSourceConfiguration configuration)
```
    Describes how the data source is configured. The specific information in the description depends on the data source provider.
    
    Parameters:
    
    configuration - Describes how the data source is configured. The specific information in the description depends on the data source provider.
  - getConfiguration
```
public DataSourceConfiguration getConfiguration()
```
    Describes how the data source is configured. The specific information in the description depends on the data source provider.
    
    Returns:
    
    Describes how the data source is configured. The specific information in the description depends on the data source provider.
  - withConfiguration
```
public DescribeDataSourceResult withConfiguration(DataSourceConfiguration configuration)
```
    Describes how the data source is configured. The specific information in the description depends on the data source provider.
    
    Parameters:
    
    configuration - Describes how the data source is configured. The specific information in the description depends on the data source provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix timestamp of when the data source was created.
    
    Parameters:
    
    createdAt - The Unix timestamp of when the data source was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix timestamp of when the data source was created.
    
    Returns:
    
    The Unix timestamp of when the data source was created.
  - withCreatedAt
```
public DescribeDataSourceResult withCreatedAt(Date createdAt)
```
    The Unix timestamp of when the data source was created.
    
    Parameters:
    
    createdAt - The Unix timestamp of when the data source was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The Unix timestamp of when the data source was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp of when the data source was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The Unix timestamp of when the data source was last updated.
    
    Returns:
    
    The Unix timestamp of when the data source was last updated.
  - withUpdatedAt
```
public DescribeDataSourceResult withUpdatedAt(Date updatedAt)
```
    The Unix timestamp of when the data source was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp of when the data source was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the data source.
    
    Parameters:
    
    description - The description of the data source.
  - getDescription
```
public String getDescription()
```
    The description of the data source.
    
    Returns:
    
    The description of the data source.
  - withDescription
```
public DescribeDataSourceResult withDescription(String description)
```
    The description of the data source.
    
    Parameters:
    
    description - The description of the data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the data source. 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.
    
    Parameters:
    
    status - The current status of the data source. 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.
    
    See Also:
    
    DataSourceStatus
  - getStatus
```
public String getStatus()
```
    The current status of the data source. 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.
    
    Returns:
    
    The current status of the data source. 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.
    
    See Also:
    
    DataSourceStatus
  - withStatus
```
public DescribeDataSourceResult withStatus(String status)
```
    The current status of the data source. 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.
    
    Parameters:
    
    status - The current status of the data source. 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceStatus
  - withStatus
```
public DescribeDataSourceResult withStatus(DataSourceStatus status)
```
    The current status of the data source. 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.
    
    Parameters:
    
    status - The current status of the data source. 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceStatus
  - setSchedule
```
public void setSchedule(String schedule)
```
    The schedule for Amazon Kendra to update the index.
    
    Parameters:
    
    schedule - The schedule for Amazon Kendra to update the index.
  - getSchedule
```
public String getSchedule()
```
    The schedule for Amazon Kendra to update the index.
    
    Returns:
    
    The schedule for Amazon Kendra to update the index.
  - withSchedule
```
public DescribeDataSourceResult withSchedule(String schedule)
```
    The schedule for Amazon Kendra to update the index.
    
    Parameters:
    
    schedule - The schedule for Amazon Kendra to update the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
  - withRoleArn
```
public DescribeDataSourceResult withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
    
    Parameters:
    
    errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
  - getErrorMessage
```
public String getErrorMessage()
```
    When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
    
    Returns:
    
    When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
  - withErrorMessage
```
public DescribeDataSourceResult withErrorMessage(String errorMessage)
```
    When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
    
    Parameters:
    
    errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String 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.
    
    Parameters:
    
    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.
  - getLanguageCode
```
public String getLanguageCode()
```
    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.
    
    Returns:
    
    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.
  - withLanguageCode
```
public DescribeDataSourceResult withLanguageCode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomDocumentEnrichmentConfiguration
```
public void setCustomDocumentEnrichmentConfiguration(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.
    
    Parameters:
    
    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.
  - getCustomDocumentEnrichmentConfiguration
```
public CustomDocumentEnrichmentConfiguration getCustomDocumentEnrichmentConfiguration()
```
    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.
    
    Returns:
    
    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.
  - withCustomDocumentEnrichmentConfiguration
```
public DescribeDataSourceResult withCustomDocumentEnrichmentConfiguration(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeDataSourceResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeDataSourceResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDataSourceResult

Method Detail

setId

getId

withId

setIndexId

getIndexId

withIndexId

setName

getName

withName

setType

getType

withType

withType

setConfiguration

getConfiguration

withConfiguration

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

setSchedule

getSchedule

withSchedule

setRoleArn

getRoleArn

withRoleArn

setErrorMessage

getErrorMessage

withErrorMessage

setLanguageCode

getLanguageCode

withLanguageCode

setCustomDocumentEnrichmentConfiguration

getCustomDocumentEnrichmentConfiguration

withCustomDocumentEnrichmentConfiguration

toString

equals

hashCode

clone