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

Class StringListAttributeBoostingConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.StringListAttributeBoostingConfiguration

All Implemented Interfaces:

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

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

Provides information on boosting STRING_LIST type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StringListAttributeBoostingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
DocumentAttributeBoostingLevel	boostingLevel()	Specifies how much a document attribute is boosted.
String	boostingLevelAsString()	Specifies how much a document attribute is boosted.
static StringListAttributeBoostingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StringListAttributeBoostingConfiguration.Builder>	serializableBuilderClass()
StringListAttributeBoostingConfiguration.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

boostingLevel

public final DocumentAttributeBoostingLevel boostingLevel()

Specifies how much a document attribute is boosted.

If the service returns an enum value that is not available in the current SDK version, boostingLevel will return DocumentAttributeBoostingLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from boostingLevelAsString().

Returns:

Specifies how much a document attribute is boosted.

See Also:

DocumentAttributeBoostingLevel

boostingLevelAsString

public final String boostingLevelAsString()

Specifies how much a document attribute is boosted.

If the service returns an enum value that is not available in the current SDK version, boostingLevel will return DocumentAttributeBoostingLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from boostingLevelAsString().

Returns:

Specifies how much a document attribute is boosted.

See Also:

DocumentAttributeBoostingLevel

toBuilder

public StringListAttributeBoostingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StringListAttributeBoostingConfiguration.Builder,StringListAttributeBoostingConfiguration>

builder

public static StringListAttributeBoostingConfiguration.Builder builder()

serializableBuilderClass

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