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

Class DataSourceSummary

java.lang.Object

software.amazon.awssdk.services.kendra.model.DataSourceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DataSourceSummary.Builder,DataSourceSummary>

@Generated("software.amazon.awssdk:codegen")
public final class DataSourceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataSourceSummary.Builder,DataSourceSummary>

Summary information for a Amazon Kendra data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataSourceSummary.Builder

Method Summary

Modifier and Type	Method	Description
static DataSourceSummary.Builder	builder()
Instant	createdAt()	The Unix timestamp when the data source connector was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier for the data source.
String	languageCode()	The code for a language.
String	name()	The name of the data source.
List<SdkField<?>>	sdkFields()
static Class<? extends DataSourceSummary.Builder>	serializableBuilderClass()
DataSourceStatus	status()	The status of the data source.
String	statusAsString()	The status of the data source.
DataSourceSummary.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.

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

name

public final String name()

The name of the data source.

Returns:

The name of the data source.

id

public final String id()

The identifier for the data source.

Returns:

The identifier for the data source.

type

public final DataSourceType type()

The type of the data source.

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.

See Also:

DataSourceType

typeAsString

public final String typeAsString()

The type of the data source.

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.

See Also:

DataSourceType

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.

status

public final DataSourceStatus status()

The status of the data source. When the status is ACTIVE the data source is ready to use.

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 status of the data source. When the status is ACTIVE the data source is ready to use.

See Also:

DataSourceStatus

statusAsString

public final String statusAsString()

The status of the data source. When the status is ACTIVE the data source is ready to use.

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 status of the data source. When the status is ACTIVE the data source is ready to use.

See Also:

DataSourceStatus

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.

toBuilder

public DataSourceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataSourceSummary.Builder,DataSourceSummary>

builder

public static DataSourceSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo