Package software.amazon.awssdk.services.qbusiness.model

Class Index

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.Index

All Implemented Interfaces:

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

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

Summary information for your Amazon Q index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Index.Builder

Method Summary

Modifier and Type	Method	Description
static Index.Builder	builder()
Instant	createdAt()	The Unix timestamp when the index was created.
String	displayName()	The name of the index.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexId()	The identifier for the index.
List<SdkField<?>>	sdkFields()
static Class<? extends Index.Builder>	serializableBuilderClass()
IndexStatus	status()	The current status of the index.
String	statusAsString()	The current status of the index.
Index.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

createdAt

public final Instant createdAt()

The Unix timestamp when the index was created.

Returns:

The Unix timestamp when the index was created.

displayName

public final String displayName()

The name of the index.

Returns:

The name of the index.

indexId

public final String indexId()

The identifier for the index.

Returns:

The identifier for the index.

status

public final IndexStatus status()

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

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.

See Also:

IndexStatus

statusAsString

public final String statusAsString()

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

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.

See Also:

IndexStatus

updatedAt

public final Instant updatedAt()

The Unix timestamp when the index was last updated.

Returns:

The Unix timestamp when the index was last updated.

toBuilder

public Index.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Index.Builder,Index>

builder

public static Index.Builder builder()

serializableBuilderClass

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