java.lang.Object
- software.amazon.awssdk.services.qbusiness.model.StringAttributeBoostingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StringAttributeBoostingConfiguration.Builder,StringAttributeBoostingConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class StringAttributeBoostingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StringAttributeBoostingConfiguration.Builder,StringAttributeBoostingConfiguration>
```
Provides information on boosting STRING 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 StringAttributeBoostingConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,StringAttributeValueBoostingLevel>`	`attributeValueBoosting()`	Specifies specific values of a `STRING` type document attribute being boosted.
`Map<String,String>`	`attributeValueBoostingAsStrings()`	Specifies specific values of a `STRING` type document attribute being boosted.
`DocumentAttributeBoostingLevel`	`boostingLevel()`	Specifies how much a document attribute is boosted.
`String`	`boostingLevelAsString()`	Specifies how much a document attribute is boosted.
`static StringAttributeBoostingConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributeValueBoosting()`	For responses, this returns true if the service returned a value for the AttributeValueBoosting property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StringAttributeBoostingConfiguration.Builder>`	`serializableBuilderClass()`
`StringAttributeBoostingConfiguration.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
  - attributeValueBoosting
```
public final Map<String,StringAttributeValueBoostingLevel> attributeValueBoosting()
```
    Specifies specific values of a STRING type document attribute being boosted.
    
    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 hasAttributeValueBoosting() method.
    
    Returns:
    
    Specifies specific values of a STRING type document attribute being boosted.
  - hasAttributeValueBoosting
```
public final boolean hasAttributeValueBoosting()
```
    For responses, this returns true if the service returned a value for the AttributeValueBoosting 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.
  - attributeValueBoostingAsStrings
```
public final Map<String,String> attributeValueBoostingAsStrings()
```
    Specifies specific values of a STRING type document attribute being boosted.
    
    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 hasAttributeValueBoosting() method.
    
    Returns:
    
    Specifies specific values of a STRING type document attribute being boosted.
  - toBuilder
```
public StringAttributeBoostingConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StringAttributeBoostingConfiguration.Builder,StringAttributeBoostingConfiguration>
  - builder
```
public static StringAttributeBoostingConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StringAttributeBoostingConfiguration.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

Class StringAttributeBoostingConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

boostingLevel

boostingLevelAsString

attributeValueBoosting

hasAttributeValueBoosting

attributeValueBoostingAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields