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

Class DocumentDetails

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.DocumentDetails

All Implemented Interfaces:

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

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

The details of a document within an Amazon Q index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentDetails.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentDetails.Builder	builder()
Instant	createdAt()	The timestamp for when the document was created.
String	documentId()	The identifier of the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorDetail	error()	An error message associated with the document.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentDetails.Builder>	serializableBuilderClass()
DocumentStatus	status()	The current status of the document.
String	statusAsString()	The current status of the document.
DocumentDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The timestamp for when the document 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 timestamp for when the document was created.

Returns:

The timestamp for when the document was created.

documentId

public final String documentId()

The identifier of the document.

Returns:

The identifier of the document.

error

public final ErrorDetail error()

An error message associated with the document.

Returns:

An error message associated with the document.

status

public final DocumentStatus status()

The current status of the document.

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

Returns:

The current status of the document.

See Also:

DocumentStatus

statusAsString

public final String statusAsString()

The current status of the document.

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

Returns:

The current status of the document.

See Also:

DocumentStatus

updatedAt

public final Instant updatedAt()

The timestamp for when the document was last updated.

Returns:

The timestamp for when the document was last updated.

toBuilder

public DocumentDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentDetails.Builder,DocumentDetails>

builder

public static DocumentDetails.Builder builder()

serializableBuilderClass

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