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

Class IndexConfigurationSummary

java.lang.Object

software.amazon.awssdk.services.kendra.model.IndexConfigurationSummary

All Implemented Interfaces:

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

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

Summary information on the configuration of an index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IndexConfigurationSummary.Builder

Method Summary

Modifier and Type	Method	Description
static IndexConfigurationSummary.Builder	builder()
Instant	createdAt()	The Unix timestamp when the index was created.
IndexEdition	edition()	Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
String	editionAsString()	Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	A identifier for the index.
String	name()	The name of the index.
List<SdkField<?>>	sdkFields()
static Class<? extends IndexConfigurationSummary.Builder>	serializableBuilderClass()
IndexStatus	status()	The current status of the index.
String	statusAsString()	The current status of the index.
IndexConfigurationSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The Unix timestamp when the index 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 index.

Returns:

The name of the index.

id

public final String id()

A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Returns:

A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

edition

public final IndexEdition edition()

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

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

Returns:

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

See Also:

IndexEdition

editionAsString

public final String editionAsString()

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

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

Returns:

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

See Also:

IndexEdition

createdAt

public final Instant createdAt()

The Unix timestamp when the index was created.

Returns:

The Unix timestamp when the index was created.

updatedAt

public final Instant updatedAt()

The Unix timestamp when the index was last updated.

Returns:

The Unix timestamp when the index was last updated.

status

public final IndexStatus status()

The current status of the index. When the status is ACTIVE, the index is ready to search.

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

Returns:

The current status of the index. When the status is ACTIVE, the index is ready to search.

See Also:

IndexStatus

statusAsString

public final String statusAsString()

The current status of the index. When the status is ACTIVE, the index is ready to search.

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

Returns:

The current status of the index. When the status is ACTIVE, the index is ready to search.

See Also:

IndexStatus

toBuilder

public IndexConfigurationSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IndexConfigurationSummary.Builder,IndexConfigurationSummary>

builder

public static IndexConfigurationSummary.Builder builder()

serializableBuilderClass

public static Class<? extends IndexConfigurationSummary.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