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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface KnowledgeBaseDocumentDetail.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KnowledgeBaseDocumentDetail.Builder`	`builder()`
`String`	`dataSourceId()`	The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`DocumentIdentifier`	`identifier()`	Contains information that identifies the document.
`String`	`knowledgeBaseId()`	The identifier of the knowledge base that the document was ingested into or deleted from.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KnowledgeBaseDocumentDetail.Builder>`	`serializableBuilderClass()`
`DocumentStatus`	`status()`	The ingestion status of the document.
`String`	`statusAsString()`	The ingestion status of the document.
`String`	`statusReason()`	The reason for the status.
`KnowledgeBaseDocumentDetail.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	The date and time at which 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
  - 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.
  - 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.
  - 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:
    
    DocumentStatus
  - 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:
    
    DocumentStatus
  - identifier
```
public final DocumentIdentifier identifier()
```
    Contains information that identifies the document.
    
    Returns:
    
    Contains information that identifies the document.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KnowledgeBaseDocumentDetail.Builder,KnowledgeBaseDocumentDetail>
  - 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)
```
    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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class KnowledgeBaseDocumentDetail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

knowledgeBaseId

dataSourceId

status

statusAsString

identifier

statusReason

updatedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField