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

Class NumberAttributeBoostingConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.NumberAttributeBoostingConfiguration

All Implemented Interfaces:

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

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

Provides information on boosting NUMBER type document attributes.

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	NumberAttributeBoostingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
final DocumentAttributeBoostingLevel	boostingLevel()	Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.
final String	boostingLevelAsString()	Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.
final NumberAttributeBoostingType	boostingType()	Specifies how much a document attribute is boosted.
final String	boostingTypeAsString()	Specifies how much a document attribute is boosted.
static NumberAttributeBoostingConfiguration.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.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends NumberAttributeBoostingConfiguration.Builder>	serializableBuilderClass()
NumberAttributeBoostingConfiguration.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.

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

boostingLevel

public final DocumentAttributeBoostingLevel boostingLevel()

Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

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 the duration, in seconds, of a boost applies to a NUMBER type document attribute.

See Also:

• DocumentAttributeBoostingLevel

boostingLevelAsString

public final String boostingLevelAsString()

Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

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 the duration, in seconds, of a boost applies to a NUMBER type document attribute.

See Also:

• DocumentAttributeBoostingLevel

boostingType

public final NumberAttributeBoostingType boostingType()

Specifies how much a document attribute is boosted.

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

Returns:

Specifies how much a document attribute is boosted.

See Also:

• NumberAttributeBoostingType

boostingTypeAsString

public final String boostingTypeAsString()

Specifies how much a document attribute is boosted.

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

Returns:

Specifies how much a document attribute is boosted.

See Also:

• NumberAttributeBoostingType

toBuilder

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

Returns:

a builder for type T

builder

public static NumberAttributeBoostingConfiguration.Builder builder()

serializableBuilderClass

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

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.