Package software.amazon.awssdk.services.kendra.model

Class DescribeDataSourceResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.DescribeDataSourceResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeDataSourceResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDataSourceResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDataSourceResponse.Builder	builder()
DataSourceConfiguration	configuration()	Configuration details for the data source connector.
Instant	createdAt()	The Unix timestamp when the data source connector was created.
CustomDocumentEnrichmentConfiguration	customDocumentEnrichmentConfiguration()	Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
String	description()	The description for the data source connector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the data source connector.
String	indexId()	The identifier of the index used with the data source connector.
String	languageCode()	The code for a language.
String	name()	The name for the data source connector.
String	roleArn()	The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
String	schedule()	The schedule for Amazon Kendra to update the index.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDataSourceResponse.Builder>	serializableBuilderClass()
DataSourceStatus	status()	The current status of the data source connector.
String	statusAsString()	The current status of the data source connector.
DescribeDataSourceResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DataSourceType	type()	The type of the data source.
String	typeAsString()	The type of the data source.
Instant	updatedAt()	The Unix timestamp when the data source connector was last updated.
DataSourceVpcConfiguration	vpcConfiguration()	Configuration information for an Amazon Virtual Private Cloud to connect to your data source.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The identifier of the data source connector.

Returns:

The identifier of the data source connector.

indexId

public final String indexId()

The identifier of the index used with the data source connector.

Returns:

The identifier of the index used with the data source connector.

name

public final String name()

The name for the data source connector.

Returns:

The name for the data source connector.

type

public final DataSourceType type()

The type of the data source. For example, SHAREPOINT.

If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the data source. For example, SHAREPOINT.

See Also:

DataSourceType

typeAsString

public final String typeAsString()

The type of the data source. For example, SHAREPOINT.

If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the data source. For example, SHAREPOINT.

See Also:

DataSourceType

configuration

public final DataSourceConfiguration 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.

Returns:

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.

vpcConfiguration

public final DataSourceVpcConfiguration vpcConfiguration()

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Returns:

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

createdAt

public final Instant createdAt()

The Unix timestamp when the data source connector was created.

Returns:

The Unix timestamp when the data source connector was created.

updatedAt

public final Instant updatedAt()

The Unix timestamp when the data source connector was last updated.

Returns:

The Unix timestamp when the data source connector was last updated.

description

public final String description()

The description for the data source connector.

Returns:

The description for the data source connector.

status

public final DataSourceStatus 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.

If the service returns an enum value that is not available in the current SDK version, status will return DataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

DataSourceStatus

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return DataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

DataSourceStatus

schedule

public final String schedule()

The schedule for Amazon Kendra to update the index.

Returns:

The schedule for Amazon Kendra to update the index.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

Returns:

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

errorMessage

public final 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.

Returns:

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

languageCode

public final 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.

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.

customDocumentEnrichmentConfiguration

public final 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.

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.

toBuilder

public DescribeDataSourceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDataSourceResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDataSourceResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo