Class KnowledgeBase

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:

  • Method Details

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

    • knowledgeBaseArn

      public final String knowledgeBaseArn()

      The Amazon Resource Name (ARN) of the knowledge base.

      Returns:
      The Amazon Resource Name (ARN) of the knowledge base.

    • description

      public final String description()

      The description of the knowledge base.

      Returns:
      The description 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.

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

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

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

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

    • createdAt

      public final Instant createdAt()

      The time the knowledge base was created.

      Returns:
      The time the knowledge base was created.

    • updatedAt

      public final Instant updatedAt()

      The time the knowledge base was last updated.

      Returns:
      The time the knowledge base was last updated.

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

    • toBuilder

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

    • 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)
      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.