Package software.amazon.awssdk.services.qbusiness.model

Class RetrieverConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.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>

Provides information on how the retriever used for your Amazon Q application is configured.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RetrieverConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static RetrieverConfiguration	fromKendraIndexConfiguration(Consumer<KendraIndexConfiguration.Builder> kendraIndexConfiguration)	Create an instance of this class with kendraIndexConfiguration() initialized to the given value.
static RetrieverConfiguration	fromKendraIndexConfiguration(KendraIndexConfiguration kendraIndexConfiguration)	Create an instance of this class with kendraIndexConfiguration() initialized to the given value.
static RetrieverConfiguration	fromNativeIndexConfiguration(Consumer<NativeIndexConfiguration.Builder> nativeIndexConfiguration)	Create an instance of this class with nativeIndexConfiguration() initialized to the given value.
static RetrieverConfiguration	fromNativeIndexConfiguration(NativeIndexConfiguration nativeIndexConfiguration)	Create an instance of this class with nativeIndexConfiguration() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KendraIndexConfiguration	kendraIndexConfiguration()	Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.
NativeIndexConfiguration	nativeIndexConfiguration()	Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.
List<SdkField<?>>	sdkFields()
static Class<? extends RetrieverConfiguration.Builder>	serializableBuilderClass()
RetrieverConfiguration.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

kendraIndexConfiguration

public final KendraIndexConfiguration kendraIndexConfiguration()

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

Returns:

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

nativeIndexConfiguration

public final NativeIndexConfiguration nativeIndexConfiguration()

Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

Returns:

Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

toBuilder

public RetrieverConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrieverConfiguration.Builder,RetrieverConfiguration>

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)

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)

fromKendraIndexConfiguration

public static RetrieverConfiguration fromKendraIndexConfiguration(KendraIndexConfiguration kendraIndexConfiguration)

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

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

Parameters:

kendraIndexConfiguration - Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

fromKendraIndexConfiguration

public static RetrieverConfiguration fromKendraIndexConfiguration(Consumer<KendraIndexConfiguration.Builder> kendraIndexConfiguration)

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

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

Parameters:

kendraIndexConfiguration - Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

fromNativeIndexConfiguration

public static RetrieverConfiguration fromNativeIndexConfiguration(NativeIndexConfiguration nativeIndexConfiguration)

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

Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

Parameters:

nativeIndexConfiguration - Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

fromNativeIndexConfiguration

public static RetrieverConfiguration fromNativeIndexConfiguration(Consumer<NativeIndexConfiguration.Builder> nativeIndexConfiguration)

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

Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

Parameters:

nativeIndexConfiguration - Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

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