DocumentAttributeBoostingConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qbusiness.model.DocumentAttributeBoostingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentAttributeBoostingConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information on boosting supported Amazon Q document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q prioritizes generating responses from content that matches the boosted 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, see Boosting using document attributes.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentAttributeBoostingConfiguration()

Constructors
Constructor and Description
`DocumentAttributeBoostingConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentAttributeBoostingConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`DateAttributeBoostingConfiguration`	`getDateConfiguration()` Provides information on boosting `DATE` type document attributes.
`NumberAttributeBoostingConfiguration`	`getNumberConfiguration()` Provides information on boosting `NUMBER` type document attributes.
`StringAttributeBoostingConfiguration`	`getStringConfiguration()` Provides information on boosting `STRING` type document attributes.
`StringListAttributeBoostingConfiguration`	`getStringListConfiguration()` Provides information on boosting `STRING_LIST` type document attributes.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDateConfiguration(DateAttributeBoostingConfiguration dateConfiguration)` Provides information on boosting `DATE` type document attributes.
`void`	`setNumberConfiguration(NumberAttributeBoostingConfiguration numberConfiguration)` Provides information on boosting `NUMBER` type document attributes.
`void`	`setStringConfiguration(StringAttributeBoostingConfiguration stringConfiguration)` Provides information on boosting `STRING` type document attributes.
`void`	`setStringListConfiguration(StringListAttributeBoostingConfiguration stringListConfiguration)` Provides information on boosting `STRING_LIST` type document attributes.
`String`	`toString()` Returns a string representation of this object.
`DocumentAttributeBoostingConfiguration`	`withDateConfiguration(DateAttributeBoostingConfiguration dateConfiguration)` Provides information on boosting `DATE` type document attributes.
`DocumentAttributeBoostingConfiguration`	`withNumberConfiguration(NumberAttributeBoostingConfiguration numberConfiguration)` Provides information on boosting `NUMBER` type document attributes.
`DocumentAttributeBoostingConfiguration`	`withStringConfiguration(StringAttributeBoostingConfiguration stringConfiguration)` Provides information on boosting `STRING` type document attributes.
`DocumentAttributeBoostingConfiguration`	`withStringListConfiguration(StringListAttributeBoostingConfiguration stringListConfiguration)` Provides information on boosting `STRING_LIST` type document attributes.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentAttributeBoostingConfiguration
```
public DocumentAttributeBoostingConfiguration()
```
- Method Detail
  - setDateConfiguration
```
public void setDateConfiguration(DateAttributeBoostingConfiguration dateConfiguration)
```
    Provides information on boosting DATE type document attributes.
    
    Parameters:
    
    dateConfiguration - Provides information on boosting DATE type document attributes.
  - getDateConfiguration
```
public DateAttributeBoostingConfiguration getDateConfiguration()
```
    Provides information on boosting DATE type document attributes.
    
    Returns:
    
    Provides information on boosting DATE type document attributes.
  - withDateConfiguration
```
public DocumentAttributeBoostingConfiguration withDateConfiguration(DateAttributeBoostingConfiguration dateConfiguration)
```
    Provides information on boosting DATE type document attributes.
    
    Parameters:
    
    dateConfiguration - Provides information on boosting DATE type document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumberConfiguration
```
public void setNumberConfiguration(NumberAttributeBoostingConfiguration numberConfiguration)
```
    Provides information on boosting NUMBER type document attributes.
    
    Parameters:
    
    numberConfiguration - Provides information on boosting NUMBER type document attributes.
  - getNumberConfiguration
```
public NumberAttributeBoostingConfiguration getNumberConfiguration()
```
    Provides information on boosting NUMBER type document attributes.
    
    Returns:
    
    Provides information on boosting NUMBER type document attributes.
  - withNumberConfiguration
```
public DocumentAttributeBoostingConfiguration withNumberConfiguration(NumberAttributeBoostingConfiguration numberConfiguration)
```
    Provides information on boosting NUMBER type document attributes.
    
    Parameters:
    
    numberConfiguration - Provides information on boosting NUMBER type document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStringConfiguration
```
public void setStringConfiguration(StringAttributeBoostingConfiguration stringConfiguration)
```
    Provides information on boosting STRING type document attributes.
    
    Parameters:
    
    stringConfiguration - Provides information on boosting STRING type document attributes.
  - getStringConfiguration
```
public StringAttributeBoostingConfiguration getStringConfiguration()
```
    Provides information on boosting STRING type document attributes.
    
    Returns:
    
    Provides information on boosting STRING type document attributes.
  - withStringConfiguration
```
public DocumentAttributeBoostingConfiguration withStringConfiguration(StringAttributeBoostingConfiguration stringConfiguration)
```
    Provides information on boosting STRING type document attributes.
    
    Parameters:
    
    stringConfiguration - Provides information on boosting STRING type document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStringListConfiguration
```
public void setStringListConfiguration(StringListAttributeBoostingConfiguration stringListConfiguration)
```
    Provides information on boosting STRING_LIST type document attributes.
    
    Parameters:
    
    stringListConfiguration - Provides information on boosting STRING_LIST type document attributes.
  - getStringListConfiguration
```
public StringListAttributeBoostingConfiguration getStringListConfiguration()
```
    Provides information on boosting STRING_LIST type document attributes.
    
    Returns:
    
    Provides information on boosting STRING_LIST type document attributes.
  - withStringListConfiguration
```
public DocumentAttributeBoostingConfiguration withStringListConfiguration(StringListAttributeBoostingConfiguration stringListConfiguration)
```
    Provides information on boosting STRING_LIST type document attributes.
    
    Parameters:
    
    stringListConfiguration - Provides information on boosting STRING_LIST type document attributes.
    
    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 DocumentAttributeBoostingConfiguration 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.

AWS SDK for Java 1.x API Reference - 1.12.679

Class DocumentAttributeBoostingConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentAttributeBoostingConfiguration

Method Detail

setDateConfiguration

getDateConfiguration

withDateConfiguration

setNumberConfiguration

getNumberConfiguration

withNumberConfiguration

setStringConfiguration

getStringConfiguration

withStringConfiguration

setStringListConfiguration

getStringListConfiguration

withStringListConfiguration

toString

equals

hashCode

clone

marshall