com.amazonaws.services.kendra.model

Class DescribeQuerySuggestionsConfigResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kendra.model.DescribeQuerySuggestionsConfigResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeQuerySuggestionsConfigResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeQuerySuggestionsConfigResult()

Method Summary

Modifier and Type	Method and Description
DescribeQuerySuggestionsConfigResult	clone()
boolean	equals(Object obj)
AttributeSuggestionsDescribeConfig	getAttributeSuggestionsConfig() Configuration information for the document fields/attributes that you want to base query suggestions on.
Boolean	getIncludeQueriesWithoutUserInformation() TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
Date	getLastClearTime() The Unix timestamp when query suggestions for an index was last cleared.
Date	getLastSuggestionsBuildTime() The Unix timestamp when query suggestions for an index was last updated.
Integer	getMinimumNumberOfQueryingUsers() The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
Integer	getMinimumQueryCount() The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
String	getMode() Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
Integer	getQueryLogLookBackWindowInDays() How recent your queries are in your query log time window (in days).
String	getStatus() Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
Integer	getTotalSuggestionsCount() The current total count of query suggestions for an index.
int	hashCode()
Boolean	isIncludeQueriesWithoutUserInformation() TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
void	setAttributeSuggestionsConfig(AttributeSuggestionsDescribeConfig attributeSuggestionsConfig) Configuration information for the document fields/attributes that you want to base query suggestions on.
void	setIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
void	setLastClearTime(Date lastClearTime) The Unix timestamp when query suggestions for an index was last cleared.
void	setLastSuggestionsBuildTime(Date lastSuggestionsBuildTime) The Unix timestamp when query suggestions for an index was last updated.
void	setMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers) The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
void	setMinimumQueryCount(Integer minimumQueryCount) The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
void	setMode(String mode) Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
void	setQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) How recent your queries are in your query log time window (in days).
void	setStatus(String status) Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
void	setTotalSuggestionsCount(Integer totalSuggestionsCount) The current total count of query suggestions for an index.
String	toString() Returns a string representation of this object.
DescribeQuerySuggestionsConfigResult	withAttributeSuggestionsConfig(AttributeSuggestionsDescribeConfig attributeSuggestionsConfig) Configuration information for the document fields/attributes that you want to base query suggestions on.
DescribeQuerySuggestionsConfigResult	withIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
DescribeQuerySuggestionsConfigResult	withLastClearTime(Date lastClearTime) The Unix timestamp when query suggestions for an index was last cleared.
DescribeQuerySuggestionsConfigResult	withLastSuggestionsBuildTime(Date lastSuggestionsBuildTime) The Unix timestamp when query suggestions for an index was last updated.
DescribeQuerySuggestionsConfigResult	withMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers) The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
DescribeQuerySuggestionsConfigResult	withMinimumQueryCount(Integer minimumQueryCount) The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
DescribeQuerySuggestionsConfigResult	withMode(Mode mode) Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
DescribeQuerySuggestionsConfigResult	withMode(String mode) Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
DescribeQuerySuggestionsConfigResult	withQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) How recent your queries are in your query log time window (in days).
DescribeQuerySuggestionsConfigResult	withStatus(QuerySuggestionsStatus status) Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
DescribeQuerySuggestionsConfigResult	withStatus(String status) Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
DescribeQuerySuggestionsConfigResult	withTotalSuggestionsCount(Integer totalSuggestionsCount) The current total count of query suggestions for an index.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeQuerySuggestionsConfigResult

public DescribeQuerySuggestionsConfigResult()

Method Detail

setMode

public void setMode(String mode)

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

Parameters:

mode - Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

See Also:

Mode

getMode

public String getMode()

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

Returns:

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

See Also:

Mode

withMode

public DescribeQuerySuggestionsConfigResult withMode(String mode)

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

Parameters:

mode - Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

Returns:

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

See Also:

Mode

withMode

public DescribeQuerySuggestionsConfigResult withMode(Mode mode)

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

Parameters:

mode - Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

Returns:

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

See Also:

Mode

setStatus

public void setStatus(String status)

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

Parameters:

status - Whether the status of query suggestions settings is currently ACTIVE or UPDATING .

Active means the current settings apply and Updating means your changed settings are in the process of applying.

See Also:

QuerySuggestionsStatus

getStatus

public String getStatus()

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

Returns:

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

See Also:

QuerySuggestionsStatus

withStatus

public DescribeQuerySuggestionsConfigResult withStatus(String status)

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

Parameters:

status - Whether the status of query suggestions settings is currently ACTIVE or UPDATING .

Active means the current settings apply and Updating means your changed settings are in the process of applying.

Returns:

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

See Also:

QuerySuggestionsStatus

withStatus

public DescribeQuerySuggestionsConfigResult withStatus(QuerySuggestionsStatus status)

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

Parameters:

status - Whether the status of query suggestions settings is currently ACTIVE or UPDATING .

Active means the current settings apply and Updating means your changed settings are in the process of applying.

Returns:

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

See Also:

QuerySuggestionsStatus

setQueryLogLookBackWindowInDays

public void setQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays)

How recent your queries are in your query log time window (in days).

Parameters:

queryLogLookBackWindowInDays - How recent your queries are in your query log time window (in days).

getQueryLogLookBackWindowInDays

public Integer getQueryLogLookBackWindowInDays()

How recent your queries are in your query log time window (in days).

Returns:

How recent your queries are in your query log time window (in days).

withQueryLogLookBackWindowInDays

public DescribeQuerySuggestionsConfigResult withQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays)

How recent your queries are in your query log time window (in days).

Parameters:

queryLogLookBackWindowInDays - How recent your queries are in your query log time window (in days).

Returns:

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

setIncludeQueriesWithoutUserInformation

public void setIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation)

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

Parameters:

includeQueriesWithoutUserInformation - TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

getIncludeQueriesWithoutUserInformation

public Boolean getIncludeQueriesWithoutUserInformation()

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

Returns:

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

withIncludeQueriesWithoutUserInformation

public DescribeQuerySuggestionsConfigResult withIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation)

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

Parameters:

includeQueriesWithoutUserInformation - TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

Returns:

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

isIncludeQueriesWithoutUserInformation

public Boolean isIncludeQueriesWithoutUserInformation()

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

Returns:

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

setMinimumNumberOfQueryingUsers

public void setMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers)

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Parameters:

minimumNumberOfQueryingUsers - The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

getMinimumNumberOfQueryingUsers

public Integer getMinimumNumberOfQueryingUsers()

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Returns:

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

withMinimumNumberOfQueryingUsers

public DescribeQuerySuggestionsConfigResult withMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers)

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Parameters:

minimumNumberOfQueryingUsers - The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Returns:

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

setMinimumQueryCount

public void setMinimumQueryCount(Integer minimumQueryCount)

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

Parameters:

minimumQueryCount - The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

getMinimumQueryCount

public Integer getMinimumQueryCount()

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

Returns:

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

withMinimumQueryCount

public DescribeQuerySuggestionsConfigResult withMinimumQueryCount(Integer minimumQueryCount)

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

Parameters:

minimumQueryCount - The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

Returns:

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

setLastSuggestionsBuildTime

public void setLastSuggestionsBuildTime(Date lastSuggestionsBuildTime)

The Unix timestamp when query suggestions for an index was last updated.

Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

Parameters:

lastSuggestionsBuildTime - The Unix timestamp when query suggestions for an index was last updated.

Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

getLastSuggestionsBuildTime

public Date getLastSuggestionsBuildTime()

The Unix timestamp when query suggestions for an index was last updated.

Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

Returns:

The Unix timestamp when query suggestions for an index was last updated.

Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

withLastSuggestionsBuildTime

public DescribeQuerySuggestionsConfigResult withLastSuggestionsBuildTime(Date lastSuggestionsBuildTime)

The Unix timestamp when query suggestions for an index was last updated.

Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

Parameters:

lastSuggestionsBuildTime - The Unix timestamp when query suggestions for an index was last updated.

Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

Returns:

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

setLastClearTime

public void setLastClearTime(Date lastClearTime)

The Unix timestamp when query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

Parameters:

lastClearTime - The Unix timestamp when query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

getLastClearTime

public Date getLastClearTime()

The Unix timestamp when query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

Returns:

The Unix timestamp when query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

withLastClearTime

public DescribeQuerySuggestionsConfigResult withLastClearTime(Date lastClearTime)

The Unix timestamp when query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

Parameters:

lastClearTime - The Unix timestamp when query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

Returns:

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

setTotalSuggestionsCount

public void setTotalSuggestionsCount(Integer totalSuggestionsCount)

The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

Parameters:

totalSuggestionsCount - The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

getTotalSuggestionsCount

public Integer getTotalSuggestionsCount()

The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

Returns:

The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

withTotalSuggestionsCount

public DescribeQuerySuggestionsConfigResult withTotalSuggestionsCount(Integer totalSuggestionsCount)

The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

Parameters:

totalSuggestionsCount - The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

Returns:

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

setAttributeSuggestionsConfig

public void setAttributeSuggestionsConfig(AttributeSuggestionsDescribeConfig attributeSuggestionsConfig)

Configuration information for the document fields/attributes that you want to base query suggestions on.

Parameters:

attributeSuggestionsConfig - Configuration information for the document fields/attributes that you want to base query suggestions on.

getAttributeSuggestionsConfig

public AttributeSuggestionsDescribeConfig getAttributeSuggestionsConfig()

Configuration information for the document fields/attributes that you want to base query suggestions on.

Returns:

Configuration information for the document fields/attributes that you want to base query suggestions on.

withAttributeSuggestionsConfig

public DescribeQuerySuggestionsConfigResult withAttributeSuggestionsConfig(AttributeSuggestionsDescribeConfig attributeSuggestionsConfig)

Configuration information for the document fields/attributes that you want to base query suggestions on.

Parameters:

attributeSuggestionsConfig - Configuration information for the document fields/attributes that you want to base query suggestions on.

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 DescribeQuerySuggestionsConfigResult clone()

Overrides:

clone in class Object