KendraConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexmodelsv2.model.KendraConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KendraConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KendraConfiguration()

Constructors
Constructor and Description
`KendraConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KendraConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKendraIndex()` The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.
`String`	`getQueryFilterString()` A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.
`Boolean`	`getQueryFilterStringEnabled()` Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
`int`	`hashCode()`
`Boolean`	`isQueryFilterStringEnabled()` Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setKendraIndex(String kendraIndex)` The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.
`void`	`setQueryFilterString(String queryFilterString)` A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.
`void`	`setQueryFilterStringEnabled(Boolean queryFilterStringEnabled)` Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
`String`	`toString()` Returns a string representation of this object.
`KendraConfiguration`	`withKendraIndex(String kendraIndex)` The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.
`KendraConfiguration`	`withQueryFilterString(String queryFilterString)` A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.
`KendraConfiguration`	`withQueryFilterStringEnabled(Boolean queryFilterStringEnabled)` Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

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

- Constructor Detail
  - KendraConfiguration
```
public KendraConfiguration()
```
- Method Detail
  - setKendraIndex
```
public void setKendraIndex(String kendraIndex)
```
    The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
    
    Parameters:
    
    kendraIndex - The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
  - getKendraIndex
```
public String getKendraIndex()
```
    The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
  - withKendraIndex
```
public KendraConfiguration withKendraIndex(String kendraIndex)
```
    The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
    
    Parameters:
    
    kendraIndex - The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryFilterStringEnabled
```
public void setQueryFilterStringEnabled(Boolean queryFilterStringEnabled)
```
    Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
    
    Parameters:
    
    queryFilterStringEnabled - Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
  - getQueryFilterStringEnabled
```
public Boolean getQueryFilterStringEnabled()
```
    Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
    
    Returns:
    
    Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
  - withQueryFilterStringEnabled
```
public KendraConfiguration withQueryFilterStringEnabled(Boolean queryFilterStringEnabled)
```
    Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
    
    Parameters:
    
    queryFilterStringEnabled - Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isQueryFilterStringEnabled
```
public Boolean isQueryFilterStringEnabled()
```
    Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
    
    Returns:
    
    Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
  - setQueryFilterString
```
public void setQueryFilterString(String queryFilterString)
```
    A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
    
    Parameters:
    
    queryFilterString - A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
  - getQueryFilterString
```
public String getQueryFilterString()
```
    A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
    
    Returns:
    
    A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
  - withQueryFilterString
```
public KendraConfiguration withQueryFilterString(String queryFilterString)
```
    A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
    
    Parameters:
    
    queryFilterString - A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
    
    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 KendraConfiguration 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.

Did this page help you?

Class KendraConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KendraConfiguration

Method Detail

setKendraIndex

getKendraIndex

withKendraIndex

setQueryFilterStringEnabled

getQueryFilterStringEnabled

withQueryFilterStringEnabled

isQueryFilterStringEnabled

setQueryFilterString

getQueryFilterString

withQueryFilterString

toString

equals

hashCode

clone

marshall