Class RetrieverConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RetrieverConfiguration

All Implemented Interfaces:

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

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

Configuration for a retriever, specified as a union of retriever types.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrieverConfiguration.Builder
static enum	RetrieverConfiguration.Type

Method Summary

Modifier and Type	Method	Description
static RetrieverConfiguration.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
static RetrieverConfiguration	fromKnowledgeBase(Consumer<KnowledgeBaseRetrieverConfiguration.Builder> knowledgeBase)	Create an instance of this class with knowledgeBase() initialized to the given value.
static RetrieverConfiguration	fromKnowledgeBase(KnowledgeBaseRetrieverConfiguration knowledgeBase)	Create an instance of this class with knowledgeBase() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final KnowledgeBaseRetrieverConfiguration	knowledgeBase()	Configuration for a knowledge base retriever.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends RetrieverConfiguration.Builder>	serializableBuilderClass()
RetrieverConfiguration.Builder	toBuilder()	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.
RetrieverConfiguration.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

knowledgeBase

public final KnowledgeBaseRetrieverConfiguration knowledgeBase()

Configuration for a knowledge base retriever.

Returns:

Configuration for a knowledge base retriever.

toBuilder

public RetrieverConfiguration.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<RetrieverConfiguration.Builder,RetrieverConfiguration>

Returns:

a builder for type T

builder

public static RetrieverConfiguration.Builder builder()

serializableBuilderClass

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

fromKnowledgeBase

public static RetrieverConfiguration fromKnowledgeBase(KnowledgeBaseRetrieverConfiguration knowledgeBase)

Create an instance of this class with knowledgeBase() initialized to the given value.

Configuration for a knowledge base retriever.

Parameters:

knowledgeBase - Configuration for a knowledge base retriever.

fromKnowledgeBase

public static RetrieverConfiguration fromKnowledgeBase(Consumer<KnowledgeBaseRetrieverConfiguration.Builder> knowledgeBase)

Create an instance of this class with knowledgeBase() initialized to the given value.

Configuration for a knowledge base retriever.

Parameters:

knowledgeBase - Configuration for a knowledge base retriever.

type

public RetrieverConfiguration.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RetrieverConfiguration.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RetrieverConfiguration.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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.