Package software.amazon.awssdk.services.bedrockagent.model

Class KnowledgeBaseSummary

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.KnowledgeBaseSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBaseSummary.Builder,KnowledgeBaseSummary>

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

Contains details about a knowledge base.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseSummary.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseSummary.Builder	builder()
String	description()	The description of the knowledge base.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	knowledgeBaseId()	The unique identifier of the knowledge base.
String	name()	The name of the knowledge base.
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseSummary.Builder>	serializableBuilderClass()
KnowledgeBaseStatus	status()	The status of the knowledge base.
String	statusAsString()	The status of the knowledge base.
KnowledgeBaseSummary.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

description

public final String description()

The description of the knowledge base.

Returns:

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

status

public final KnowledgeBaseStatus status()

The status of the knowledge base.

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.

See Also:

KnowledgeBaseStatus

statusAsString

public final String statusAsString()

The status of the knowledge base.

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.

See Also:

KnowledgeBaseStatus

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 KnowledgeBaseSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseSummary.Builder,KnowledgeBaseSummary>

builder

public static KnowledgeBaseSummary.Builder builder()

serializableBuilderClass

public static Class<? extends KnowledgeBaseSummary.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