Class KnowledgeBaseDocumentDetail

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.KnowledgeBaseDocumentDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBaseDocumentDetail.Builder,KnowledgeBaseDocumentDetail>
@Generated("software.amazon.awssdk:codegen") public final class KnowledgeBaseDocumentDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBaseDocumentDetail.Builder,KnowledgeBaseDocumentDetail>

Contains the details for a document that was ingested or deleted.

See Also:

  • Method Details

    • dataSourceId

      public final String dataSourceId()

      The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.

      Returns:
      The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.

    • identifier

      public final DocumentIdentifier identifier()

      Contains information that identifies the document.

      Returns:
      Contains information that identifies the document.

    • knowledgeBaseId

      public final String knowledgeBaseId()

      The identifier of the knowledge base that the document was ingested into or deleted from.

      Returns:
      The identifier of the knowledge base that the document was ingested into or deleted from.

    • status

      public final DocumentStatus status()

      The ingestion status of the document. The following statuses are possible:

      • STARTED – You submitted the ingestion job containing the document.

      • PENDING – The document is waiting to be ingested.

      • IN_PROGRESS – The document is being ingested.

      • INDEXED – The document was successfully indexed.

      • PARTIALLY_INDEXED – The document was partially indexed.

      • METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

      • METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

      • FAILED – The document failed to be ingested.

      • NOT_FOUND – The document wasn't found.

      • IGNORED – The document was ignored during ingestion.

      • DELETING – You submitted the delete job containing the document.

      • DELETE_IN_PROGRESS – The document is being deleted.

      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 ingestion status of the document. The following statuses are possible:

      • STARTED – You submitted the ingestion job containing the document.

      • PENDING – The document is waiting to be ingested.

      • IN_PROGRESS – The document is being ingested.

      • INDEXED – The document was successfully indexed.

      • PARTIALLY_INDEXED – The document was partially indexed.

      • METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

      • METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

      • FAILED – The document failed to be ingested.

      • NOT_FOUND – The document wasn't found.

      • IGNORED – The document was ignored during ingestion.

      • DELETING – You submitted the delete job containing the document.

      • DELETE_IN_PROGRESS – The document is being deleted.

      See Also:

    • statusAsString

      public final String statusAsString()

      The ingestion status of the document. The following statuses are possible:

      • STARTED – You submitted the ingestion job containing the document.

      • PENDING – The document is waiting to be ingested.

      • IN_PROGRESS – The document is being ingested.

      • INDEXED – The document was successfully indexed.

      • PARTIALLY_INDEXED – The document was partially indexed.

      • METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

      • METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

      • FAILED – The document failed to be ingested.

      • NOT_FOUND – The document wasn't found.

      • IGNORED – The document was ignored during ingestion.

      • DELETING – You submitted the delete job containing the document.

      • DELETE_IN_PROGRESS – The document is being deleted.

      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 ingestion status of the document. The following statuses are possible:

      • STARTED – You submitted the ingestion job containing the document.

      • PENDING – The document is waiting to be ingested.

      • IN_PROGRESS – The document is being ingested.

      • INDEXED – The document was successfully indexed.

      • PARTIALLY_INDEXED – The document was partially indexed.

      • METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

      • METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

      • FAILED – The document failed to be ingested.

      • NOT_FOUND – The document wasn't found.

      • IGNORED – The document was ignored during ingestion.

      • DELETING – You submitted the delete job containing the document.

      • DELETE_IN_PROGRESS – The document is being deleted.

      See Also:

    • statusReason

      public final String statusReason()

      The reason for the status. Appears alongside the status IGNORED.

      Returns:
      The reason for the status. Appears alongside the status IGNORED.

    • updatedAt

      public final Instant updatedAt()

      The date and time at which the document was last updated.

      Returns:
      The date and time at which the document was last updated.

    • toBuilder

      public KnowledgeBaseDocumentDetail.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<KnowledgeBaseDocumentDetail.Builder,KnowledgeBaseDocumentDetail>
      Returns:
      a builder for type T

    • builder

      public static KnowledgeBaseDocumentDetail.Builder builder()

    • serializableBuilderClass

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