Class DocumentDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentDetails.Builder,
DocumentDetails>
The details of a document within an Amazon Q Business index.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentDetails.Builder
builder()
final Instant
The timestamp for when the document was created.final String
The identifier of the document.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorDetail
error()
An error message associated with the document.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends DocumentDetails.Builder> final DocumentStatus
status()
The current status of the document.final String
The current status of the document.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The timestamp for when the document was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
documentId
The identifier of the document.
- Returns:
- The identifier of the document.
-
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 returnDocumentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the document.
- See Also:
-
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 returnDocumentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the document.
- See Also:
-
error
An error message associated with the document.
- Returns:
- An error message associated with the document.
-
createdAt
The timestamp for when the document was created.
- Returns:
- The timestamp for when the document was created.
-
updatedAt
The timestamp for when the document was last updated.
- Returns:
- The timestamp for when the document was last updated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DocumentDetails.Builder,
DocumentDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-