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

Class NativeIndexConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.NativeIndexConfiguration

All Implemented Interfaces:

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

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

Configuration information for an Amazon Q Business index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NativeIndexConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,DocumentAttributeBoostingConfiguration>	boostingOverride()	Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
static NativeIndexConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBoostingOverride()	For responses, this returns true if the service returned a value for the BoostingOverride property.
int	hashCode()
String	indexId()	The identifier for the Amazon Q Business index.
List<SdkField<?>>	sdkFields()
static Class<? extends NativeIndexConfiguration.Builder>	serializableBuilderClass()
NativeIndexConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of 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

indexId

public final String indexId()

The identifier for the Amazon Q Business index.

Returns:

The identifier for the Amazon Q Business index.

hasBoostingOverride

public final boolean hasBoostingOverride()

For responses, this returns true if the service returned a value for the BoostingOverride property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

boostingOverride

public final Map<String,DocumentAttributeBoostingConfiguration> boostingOverride()

Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

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 hasBoostingOverride() method.

Returns:

Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

toBuilder

public NativeIndexConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NativeIndexConfiguration.Builder,NativeIndexConfiguration>

builder

public static NativeIndexConfiguration.Builder builder()

serializableBuilderClass

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