Class KnowledgeBase
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KnowledgeBase.Builder,
KnowledgeBase>
Contains information about a knowledge base.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic KnowledgeBase.Builder
builder()
final Instant
The time at which the knowledge base was created.final String
The description of the knowledge base.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.A list of reasons that the API operation on the knowledge base failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FailureReasons property.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the knowledge base.Contains details about the embeddings configuration of the knowledge base.final String
The unique identifier of the knowledge base.final String
name()
The name of the knowledge base.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.static Class
<? extends KnowledgeBase.Builder> final KnowledgeBaseStatus
status()
The status of the knowledge base.final String
The status of the knowledge base.final StorageConfiguration
Contains details about the storage configuration of the knowledge base.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The time at which the knowledge base was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createdAt
The time at which the knowledge base was created.
- Returns:
- The time at which the knowledge base was created.
-
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 theisEmpty()
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
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
The Amazon Resource Name (ARN) of the knowledge base.
- Returns:
- The Amazon Resource Name (ARN) of the knowledge base.
-
knowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
- Returns:
- Contains details about the embeddings configuration of the knowledge base.
-
knowledgeBaseId
The unique identifier of the knowledge base.
- Returns:
- The unique identifier of the knowledge base.
-
name
The name of the knowledge base.
- Returns:
- The name of the knowledge base.
-
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
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 returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
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 returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
-
storageConfiguration
Contains details about the storage configuration of the knowledge base.
- Returns:
- Contains details about the storage configuration of the knowledge base.
-
updatedAt
The time at which the knowledge base was last updated.
- Returns:
- The time at which the knowledge base was last updated.
-
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 interfaceToCopyableBuilder<KnowledgeBase.Builder,
KnowledgeBase> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-