java.lang.Object
- software.amazon.awssdk.services.bedrockagent.model.KnowledgeBase

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>

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

Contains information about a knowledge base.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface KnowledgeBase.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KnowledgeBase.Builder`	`builder()`
`Instant`	`createdAt()`	The time at which the knowledge base was created.
`String`	`description()`	The description of the knowledge base.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`failureReasons()`	A list of reasons that the API operation on the knowledge base failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFailureReasons()`	For responses, this returns true if the service returned a value for the FailureReasons property.
`int`	`hashCode()`
`String`	`knowledgeBaseArn()`	The Amazon Resource Name (ARN) of the knowledge base.
`KnowledgeBaseConfiguration`	`knowledgeBaseConfiguration()`	Contains details about the embeddings configuration of the knowledge base.
`String`	`knowledgeBaseId()`	The unique identifier of the knowledge base.
`String`	`name()`	The name of the knowledge base.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KnowledgeBase.Builder>`	`serializableBuilderClass()`
`KnowledgeBaseStatus`	`status()`	The status of the knowledge base.
`String`	`statusAsString()`	The status of the knowledge base.
`StorageConfiguration`	`storageConfiguration()`	Contains details about the storage configuration of the knowledge base.
`KnowledgeBase.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	The time at which the knowledge base 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 time at which the knowledge base was created.
    
    Returns:
    
    The time at which the knowledge base was created.
  - description
```
public final String description()
```
    The description of the knowledge base.
    
    Returns:
    
    The description of the knowledge base.
  - hasFailureReasons
```
public final boolean hasFailureReasons()
```
    For responses, this returns true if the service returned a value for the FailureReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - failureReasons
```
public final List<String> failureReasons()
```
    A list of reasons that the API operation on the knowledge base failed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailureReasons() method.
    
    Returns:
    
    A list of reasons that the API operation on the knowledge base failed.
  - knowledgeBaseArn
```
public final String knowledgeBaseArn()
```
    The Amazon Resource Name (ARN) of the knowledge base.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - knowledgeBaseConfiguration
```
public final KnowledgeBaseConfiguration knowledgeBaseConfiguration()
```
    Contains details about the embeddings configuration of the knowledge base.
    
    Returns:
    
    Contains details about the embeddings configuration of the knowledge base.
  - knowledgeBaseId
```
public final String knowledgeBaseId()
```
    The unique identifier of the knowledge base.
    
    Returns:
    
    The unique identifier of the knowledge base.
  - name
```
public final String name()
```
    The name of the knowledge base.
    
    Returns:
    
    The name of the knowledge base.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
  - status
```
public final KnowledgeBaseStatus status()
```
    The status of the knowledge base. The following statuses are possible:
    
    CREATING – The knowledge base is being created.
    
    ACTIVE – The knowledge base is ready to be queried.
    
    DELETING – The knowledge base is being deleted.
    
    UPDATING – The knowledge base is being updated.
    
    FAILED – The knowledge base API operation failed.
    
    If the service returns an enum value that is not available in the current SDK version, status will return KnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the knowledge base. The following statuses are possible:
    
    CREATING – The knowledge base is being created.
    
    ACTIVE – The knowledge base is ready to be queried.
    
    DELETING – The knowledge base is being deleted.
    
    UPDATING – The knowledge base is being updated.
    
    FAILED – The knowledge base API operation failed.
    
    See Also:
    
    KnowledgeBaseStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the knowledge base. The following statuses are possible:
    
    CREATING – The knowledge base is being created.
    
    ACTIVE – The knowledge base is ready to be queried.
    
    DELETING – The knowledge base is being deleted.
    
    UPDATING – The knowledge base is being updated.
    
    FAILED – The knowledge base API operation failed.
    
    If the service returns an enum value that is not available in the current SDK version, status will return KnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the knowledge base. The following statuses are possible:
    
    CREATING – The knowledge base is being created.
    
    ACTIVE – The knowledge base is ready to be queried.
    
    DELETING – The knowledge base is being deleted.
    
    UPDATING – The knowledge base is being updated.
    
    FAILED – The knowledge base API operation failed.
    
    See Also:
    
    KnowledgeBaseStatus
  - storageConfiguration
```
public final StorageConfiguration storageConfiguration()
```
    Contains details about the storage configuration of the knowledge base.
    
    Returns:
    
    Contains details about the storage configuration of the knowledge base.
  - updatedAt
```
public final Instant updatedAt()
```
    The time at which the knowledge base was last updated.
    
    Returns:
    
    The time at which the knowledge base was last updated.
  - toBuilder
```
public KnowledgeBase.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>
  - builder
```
public static KnowledgeBase.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends KnowledgeBase.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

Class KnowledgeBase

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

createdAt

description

hasFailureReasons

failureReasons

knowledgeBaseArn

knowledgeBaseConfiguration

knowledgeBaseId

name

roleArn

status

statusAsString

storageConfiguration

updatedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields