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 the information of a knowledge base.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceKnowledgeBase.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static KnowledgeBase.Builderbuilder()InstantcreatedAt()Returns the value of the CreatedAt property for this object.Stringdescription()Returns the value of the Description property for this object.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>failureReasons()Returns the value of the FailureReasons property for this object.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFailureReasons()For responses, this returns true if the service returned a value for the FailureReasons property.inthashCode()StringknowledgeBaseArn()Returns the value of the KnowledgeBaseArn property for this object.KnowledgeBaseConfigurationknowledgeBaseConfiguration()Returns the value of the KnowledgeBaseConfiguration property for this object.StringknowledgeBaseId()Returns the value of the KnowledgeBaseId property for this object.Stringname()Returns the value of the Name property for this object.StringroleArn()Returns the value of the RoleArn property for this object.List<SdkField<?>>sdkFields()static Class<? extends KnowledgeBase.Builder>serializableBuilderClass()KnowledgeBaseStatusstatus()Returns the value of the Status property for this object.StringstatusAsString()Returns the value of the Status property for this object.StorageConfigurationstorageConfiguration()Returns the value of the StorageConfiguration property for this object.KnowledgeBase.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()Returns the value of the UpdatedAt property for this object.-
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()
Returns the value of the KnowledgeBaseId property for this object.- Returns:
- The value of the KnowledgeBaseId property for this object.
-
name
public final String name()
Returns the value of the Name property for this object.- Returns:
- The value of the Name property for this object.
-
knowledgeBaseArn
public final String knowledgeBaseArn()
Returns the value of the KnowledgeBaseArn property for this object.- Returns:
- The value of the KnowledgeBaseArn property for this object.
-
description
public final String description()
Returns the value of the Description property for this object.- Returns:
- The value of the Description property for this object.
-
roleArn
public final String roleArn()
Returns the value of the RoleArn property for this object.- Returns:
- The value of the RoleArn property for this object.
-
knowledgeBaseConfiguration
public final KnowledgeBaseConfiguration knowledgeBaseConfiguration()
Returns the value of the KnowledgeBaseConfiguration property for this object.- Returns:
- The value of the KnowledgeBaseConfiguration property for this object.
-
storageConfiguration
public final StorageConfiguration storageConfiguration()
Returns the value of the StorageConfiguration property for this object.- Returns:
- The value of the StorageConfiguration property for this object.
-
status
public final KnowledgeBaseStatus status()
Returns the value of the Status property for this object.If the service returns an enum value that is not available in the current SDK version,
statuswill returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The value of the Status property for this object.
- See Also:
KnowledgeBaseStatus
-
statusAsString
public final String statusAsString()
Returns the value of the Status property for this object.If the service returns an enum value that is not available in the current SDK version,
statuswill returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The value of the Status property for this object.
- See Also:
KnowledgeBaseStatus
-
createdAt
public final Instant createdAt()
Returns the value of the CreatedAt property for this object.- Returns:
- The value of the CreatedAt property for this object.
-
updatedAt
public final Instant updatedAt()
Returns the value of the UpdatedAt property for this object.- Returns:
- The value of the UpdatedAt property for this object.
-
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
public final List<String> failureReasons()
Returns the value of the FailureReasons property for this object.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:
- The value of the FailureReasons property for this object.
-
toBuilder
public KnowledgeBase.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>
-
builder
public static KnowledgeBase.Builder builder()
-
serializableBuilderClass
public static Class<? extends KnowledgeBase.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-