com.amazonaws.services.qbusiness.model

Class StringAttributeBoostingConfiguration

java.lang.Object

com.amazonaws.services.qbusiness.model.StringAttributeBoostingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StringAttributeBoostingConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringAttributeBoostingConfiguration()

Method Summary

Modifier and Type	Method and Description
StringAttributeBoostingConfiguration	addAttributeValueBoostingEntry(String key, String value) Add a single AttributeValueBoosting entry
StringAttributeBoostingConfiguration	clearAttributeValueBoostingEntries() Removes all the entries added into AttributeValueBoosting.
StringAttributeBoostingConfiguration	clone()
boolean	equals(Object obj)
Map<String,String>	getAttributeValueBoosting() Specifies specific values of a STRING type document attribute being boosted.
String	getBoostingLevel() Specifies how much a document attribute is boosted.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttributeValueBoosting(Map<String,String> attributeValueBoosting) Specifies specific values of a STRING type document attribute being boosted.
void	setBoostingLevel(String boostingLevel) Specifies how much a document attribute is boosted.
String	toString() Returns a string representation of this object.
StringAttributeBoostingConfiguration	withAttributeValueBoosting(Map<String,String> attributeValueBoosting) Specifies specific values of a STRING type document attribute being boosted.
StringAttributeBoostingConfiguration	withBoostingLevel(DocumentAttributeBoostingLevel boostingLevel) Specifies how much a document attribute is boosted.
StringAttributeBoostingConfiguration	withBoostingLevel(String boostingLevel) Specifies how much a document attribute is boosted.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StringAttributeBoostingConfiguration

public StringAttributeBoostingConfiguration()

Method Detail

setBoostingLevel

public void setBoostingLevel(String boostingLevel)

Specifies how much a document attribute is boosted.

Parameters:

boostingLevel - Specifies how much a document attribute is boosted.

See Also:

DocumentAttributeBoostingLevel

getBoostingLevel

public String getBoostingLevel()

Specifies how much a document attribute is boosted.

Returns:

Specifies how much a document attribute is boosted.

See Also:

DocumentAttributeBoostingLevel

withBoostingLevel

public StringAttributeBoostingConfiguration withBoostingLevel(String boostingLevel)

Specifies how much a document attribute is boosted.

Parameters:

boostingLevel - Specifies how much a document attribute is boosted.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentAttributeBoostingLevel

withBoostingLevel

public StringAttributeBoostingConfiguration withBoostingLevel(DocumentAttributeBoostingLevel boostingLevel)

Specifies how much a document attribute is boosted.

Parameters:

boostingLevel - Specifies how much a document attribute is boosted.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentAttributeBoostingLevel

getAttributeValueBoosting

public Map<String,String> getAttributeValueBoosting()

Specifies specific values of a STRING type document attribute being boosted.

Returns:

Specifies specific values of a STRING type document attribute being boosted.

setAttributeValueBoosting

public void setAttributeValueBoosting(Map<String,String> attributeValueBoosting)

Specifies specific values of a STRING type document attribute being boosted.

Parameters:

attributeValueBoosting - Specifies specific values of a STRING type document attribute being boosted.

withAttributeValueBoosting

public StringAttributeBoostingConfiguration withAttributeValueBoosting(Map<String,String> attributeValueBoosting)

Specifies specific values of a STRING type document attribute being boosted.

Parameters:

attributeValueBoosting - Specifies specific values of a STRING type document attribute being boosted.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAttributeValueBoostingEntry

public StringAttributeBoostingConfiguration addAttributeValueBoostingEntry(String key,
                                                                           String value)

Add a single AttributeValueBoosting entry

See Also:

withAttributeValueBoosting(java.util.Map<java.lang.String, java.lang.String>)

clearAttributeValueBoostingEntries

public StringAttributeBoostingConfiguration clearAttributeValueBoostingEntries()

Removes all the entries added into AttributeValueBoosting.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StringAttributeBoostingConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.