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 Business index.

See Also:

  • Method Details

    • documentId

      public final String documentId()

      The identifier of the document.

      Returns:
      The identifier of 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:

    • 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:

    • error

      public final ErrorDetail error()

      An error message associated with the document.

      Returns:
      An error message associated with the document.

    • createdAt

      public final Instant createdAt()

      The timestamp for when the document was created.

      Returns:
      The timestamp for when the document was created.

    • 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()
      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 interface ToCopyableBuilder<DocumentDetails.Builder,DocumentDetails>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.