Class StringAttributeBoostingConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies specific values of aSTRING
type document attribute being boosted.Specifies specific values of aSTRING
type document attribute being boosted.Specifies how much a document attribute is boosted.final String
Specifies how much a document attribute is boosted.builder()
final boolean
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 boolean
For responses, this returns true if the service returned a value for the AttributeValueBoosting property.final int
hashCode()
static Class
<? extends StringAttributeBoostingConfiguration.Builder> 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnDocumentAttributeBoostingLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromboostingLevelAsString()
.- Returns:
- Specifies how much a document attribute is boosted.
- See Also:
-
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 returnDocumentAttributeBoostingLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromboostingLevelAsString()
.- Returns:
- Specifies how much a document attribute is boosted.
- See Also:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<StringAttributeBoostingConfiguration.Builder,
StringAttributeBoostingConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends StringAttributeBoostingConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-