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)
Boolean	getIncludeQueriesWithoutUserInformation() Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.
Date	getLastClearTime() Shows the date-time query suggestions for an index was last cleared.
Date	getLastSuggestionsBuildTime() Shows the date-time query suggestions for an index was last updated.
Integer	getMinimumNumberOfQueryingUsers() Shows 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() Shows 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() Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
Integer	getQueryLogLookBackWindowInDays() Shows how recent your queries are in your query log time window (in days).
String	getStatus() Shows whether the status of query suggestions settings is currently Active or Updating.
Integer	getTotalSuggestionsCount() Shows the current total count of query suggestions for an index.
int	hashCode()
Boolean	isIncludeQueriesWithoutUserInformation() Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.
void	setIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.
void	setLastClearTime(Date lastClearTime) Shows the date-time query suggestions for an index was last cleared.
void	setLastSuggestionsBuildTime(Date lastSuggestionsBuildTime) Shows the date-time query suggestions for an index was last updated.
void	setMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers) Shows 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) Shows 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) Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
void	setQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) Shows how recent your queries are in your query log time window (in days).
void	setStatus(String status) Shows whether the status of query suggestions settings is currently Active or Updating.
void	setTotalSuggestionsCount(Integer totalSuggestionsCount) Shows the current total count of query suggestions for an index.
String	toString() Returns a string representation of this object.
DescribeQuerySuggestionsConfigResult	withIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.
DescribeQuerySuggestionsConfigResult	withLastClearTime(Date lastClearTime) Shows the date-time query suggestions for an index was last cleared.
DescribeQuerySuggestionsConfigResult	withLastSuggestionsBuildTime(Date lastSuggestionsBuildTime) Shows the date-time query suggestions for an index was last updated.
DescribeQuerySuggestionsConfigResult	withMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers) Shows 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) Shows 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) Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
DescribeQuerySuggestionsConfigResult	withMode(String mode) Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
DescribeQuerySuggestionsConfigResult	withQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) Shows how recent your queries are in your query log time window (in days).
DescribeQuerySuggestionsConfigResult	withStatus(QuerySuggestionsStatus status) Shows whether the status of query suggestions settings is currently Active or Updating.
DescribeQuerySuggestionsConfigResult	withStatus(String status) Shows whether the status of query suggestions settings is currently Active or Updating.
DescribeQuerySuggestionsConfigResult	withTotalSuggestionsCount(Integer totalSuggestionsCount) Shows 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)

Shows 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 - Shows 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()

Shows 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:

Shows 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)

Shows 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 - Shows 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)

Shows 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 - Shows 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)

Shows 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 - Shows 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()

Shows 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:

Shows 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)

Shows 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 - Shows 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)

Shows 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 - Shows 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)

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

Parameters:

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

getQueryLogLookBackWindowInDays

public Integer getQueryLogLookBackWindowInDays()

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

Returns:

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

withQueryLogLookBackWindowInDays

public DescribeQuerySuggestionsConfigResult withQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays)

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

Parameters:

queryLogLookBackWindowInDays - Shows 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)

Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

Parameters:

includeQueriesWithoutUserInformation - Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

getIncludeQueriesWithoutUserInformation

public Boolean getIncludeQueriesWithoutUserInformation()

Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

Returns:

Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

withIncludeQueriesWithoutUserInformation

public DescribeQuerySuggestionsConfigResult withIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation)

Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

Parameters:

includeQueriesWithoutUserInformation - Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

Returns:

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

isIncludeQueriesWithoutUserInformation

public Boolean isIncludeQueriesWithoutUserInformation()

Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

Returns:

Shows whether Amazon Kendra uses all queries or only uses queries that include user information to generate query suggestions.

setMinimumNumberOfQueryingUsers

public void setMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers)

Shows 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 - Shows 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()

Shows 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:

Shows 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)

Shows 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 - Shows 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)

Shows 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 - Shows 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()

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

Returns:

Shows 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)

Shows 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 - Shows 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)

Shows the date-time query suggestions for an index was last updated.

Parameters:

lastSuggestionsBuildTime - Shows the date-time query suggestions for an index was last updated.

getLastSuggestionsBuildTime

public Date getLastSuggestionsBuildTime()

Shows the date-time query suggestions for an index was last updated.

Returns:

Shows the date-time query suggestions for an index was last updated.

withLastSuggestionsBuildTime

public DescribeQuerySuggestionsConfigResult withLastSuggestionsBuildTime(Date lastSuggestionsBuildTime)

Shows the date-time query suggestions for an index was last updated.

Parameters:

lastSuggestionsBuildTime - Shows the date-time query suggestions for an index was last updated.

Returns:

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

setLastClearTime

public void setLastClearTime(Date lastClearTime)

Shows the date-time 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 - Shows the date-time 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()

Shows the date-time 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:

Shows the date-time 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)

Shows the date-time 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 - Shows the date-time 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)

Shows 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.

Parameters:

totalSuggestionsCount - Shows 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.

getTotalSuggestionsCount

public Integer getTotalSuggestionsCount()

Shows 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.

Returns:

Shows 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.

withTotalSuggestionsCount

public DescribeQuerySuggestionsConfigResult withTotalSuggestionsCount(Integer totalSuggestionsCount)

Shows 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.

Parameters:

totalSuggestionsCount - Shows 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.

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