* The identifier of the index with query suggestions you want to update. *
*/ private String indexId; /** *
* Set the mode to ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query
* suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date
* for when you are ready to switch to ENABLED mode again.
*
* How recent your queries are in your query log time window. *
** The time window is the number of days from current day to past days. *
** By default, Amazon Kendra sets this to 180. *
*/ private Integer queryLogLookBackWindowInDays; /** *
* TRUE to include queries without user information (i.e. all queries, irrespective of the user),
* otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE
* and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*
* The minimum number of unique users who must search a query in order for the query to be eligible to suggest to * your users. *
** Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by * many users and is truly popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
*/ private Integer minimumNumberOfQueryingUsers; /** ** The the minimum number of times a query must be searched in order to be eligible to suggest to your users. *
** Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as * it sets a low bar for a query to be considered popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
*/ private Integer minimumQueryCount; /** ** Configuration information for the document fields/attributes that you want to base query suggestions on. *
*/ private AttributeSuggestionsUpdateConfig attributeSuggestionsConfig; /** ** The identifier of the index with query suggestions you want to update. *
* * @param indexId * The identifier of the index with query suggestions you want to update. */ public void setIndexId(String indexId) { this.indexId = indexId; } /** ** The identifier of the index with query suggestions you want to update. *
* * @return The identifier of the index with query suggestions you want to update. */ public String getIndexId() { return this.indexId; } /** ** The identifier of the index with query suggestions you want to update. *
* * @param indexId * The identifier of the index with query suggestions you want to update. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateQuerySuggestionsConfigRequest withIndexId(String indexId) { setIndexId(indexId); return this; } /** *
* Set the mode to ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query
* suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date
* for when you are ready to switch to ENABLED mode again.
*
ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off
* query suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up
* to date for when you are ready to switch to ENABLED mode again.
* @see Mode
*/
public void setMode(String mode) {
this.mode = mode;
}
/**
*
* Set the mode to ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query
* suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date
* for when you are ready to switch to ENABLED mode again.
*
ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off
* query suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up
* to date for when you are ready to switch to ENABLED mode again.
* @see Mode
*/
public String getMode() {
return this.mode;
}
/**
*
* Set the mode to ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query
* suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date
* for when you are ready to switch to ENABLED mode again.
*
ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off
* query suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up
* to date for when you are ready to switch to ENABLED mode again.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mode
*/
public UpdateQuerySuggestionsConfigRequest withMode(String mode) {
setMode(mode);
return this;
}
/**
*
* Set the mode to ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query
* suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date
* for when you are ready to switch to ENABLED mode again.
*
ENABLED or LEARN_ONLY.
*
* By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off
* query suggestions. You can to update this at any time.
*
* In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up
* to date for when you are ready to switch to ENABLED mode again.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mode
*/
public UpdateQuerySuggestionsConfigRequest withMode(Mode mode) {
this.mode = mode.toString();
return this;
}
/**
*
* How recent your queries are in your query log time window. *
** The time window is the number of days from current day to past days. *
** By default, Amazon Kendra sets this to 180. *
* * @param queryLogLookBackWindowInDays * How recent your queries are in your query log time window. ** The time window is the number of days from current day to past days. *
** By default, Amazon Kendra sets this to 180. */ public void setQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) { this.queryLogLookBackWindowInDays = queryLogLookBackWindowInDays; } /** *
* How recent your queries are in your query log time window. *
** The time window is the number of days from current day to past days. *
** By default, Amazon Kendra sets this to 180. *
* * @return How recent your queries are in your query log time window. ** The time window is the number of days from current day to past days. *
** By default, Amazon Kendra sets this to 180. */ public Integer getQueryLogLookBackWindowInDays() { return this.queryLogLookBackWindowInDays; } /** *
* How recent your queries are in your query log time window. *
** The time window is the number of days from current day to past days. *
** By default, Amazon Kendra sets this to 180. *
* * @param queryLogLookBackWindowInDays * How recent your queries are in your query log time window. ** The time window is the number of days from current day to past days. *
** By default, Amazon Kendra sets this to 180. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateQuerySuggestionsConfigRequest withQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) { setQueryLogLookBackWindowInDays(queryLogLookBackWindowInDays); return this; } /** *
* TRUE to include queries without user information (i.e. all queries, irrespective of the user),
* otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE
* and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*
TRUE to include queries without user information (i.e. all queries, irrespective of the
* user), otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to
* FALSE and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*/
public void setIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) {
this.includeQueriesWithoutUserInformation = includeQueriesWithoutUserInformation;
}
/**
*
* TRUE to include queries without user information (i.e. all queries, irrespective of the user),
* otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE
* and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*
TRUE to include queries without user information (i.e. all queries, irrespective of the
* user), otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to
* FALSE and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*/
public Boolean getIncludeQueriesWithoutUserInformation() {
return this.includeQueriesWithoutUserInformation;
}
/**
*
* TRUE to include queries without user information (i.e. all queries, irrespective of the user),
* otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE
* and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*
TRUE to include queries without user information (i.e. all queries, irrespective of the
* user), otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to
* FALSE and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateQuerySuggestionsConfigRequest withIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) {
setIncludeQueriesWithoutUserInformation(includeQueriesWithoutUserInformation);
return this;
}
/**
*
* TRUE to include queries without user information (i.e. all queries, irrespective of the user),
* otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE
* and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*
TRUE to include queries without user information (i.e. all queries, irrespective of the
* user), otherwise FALSE to only include queries with user information.
*
* If you pass user information to Amazon Kendra along with the queries, you can set this flag to
* FALSE and instruct Amazon Kendra to only consider queries with user information.
*
* If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for
* suggestions.
*
* If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
*/
public Boolean isIncludeQueriesWithoutUserInformation() {
return this.includeQueriesWithoutUserInformation;
}
/**
*
* The minimum number of unique users who must search a query in order for the query to be eligible to suggest to * your users. *
** Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by * many users and is truly popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
* * @param 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. ** Increasing this number might decrease the number of suggestions. However, this ensures a query is searched * by many users and is truly popular to suggest to users. *
** How you tune this setting depends on your specific needs. */ public void setMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers) { this.minimumNumberOfQueryingUsers = 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. *
** Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by * many users and is truly popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
* * @return The minimum number of unique users who must search a query in order for the query to be eligible to * suggest to your users. ** Increasing this number might decrease the number of suggestions. However, this ensures a query is * searched by many users and is truly popular to suggest to users. *
** How you tune this setting depends on your specific needs. */ public Integer getMinimumNumberOfQueryingUsers() { return this.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. *
** Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by * many users and is truly popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
* * @param 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. ** Increasing this number might decrease the number of suggestions. However, this ensures a query is searched * by many users and is truly popular to suggest to users. *
** How you tune this setting depends on your specific needs. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateQuerySuggestionsConfigRequest withMinimumNumberOfQueryingUsers(Integer minimumNumberOfQueryingUsers) { setMinimumNumberOfQueryingUsers(minimumNumberOfQueryingUsers); return this; } /** *
* The the minimum number of times a query must be searched in order to be eligible to suggest to your users. *
** Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as * it sets a low bar for a query to be considered popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
* * @param minimumQueryCount * The the minimum number of times a query must be searched in order to be eligible to suggest to your * users. ** Decreasing this number increases the number of suggestions. However, this affects the quality of * suggestions as it sets a low bar for a query to be considered popular to suggest to users. *
** How you tune this setting depends on your specific needs. */ public void setMinimumQueryCount(Integer minimumQueryCount) { this.minimumQueryCount = minimumQueryCount; } /** *
* The the minimum number of times a query must be searched in order to be eligible to suggest to your users. *
** Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as * it sets a low bar for a query to be considered popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
* * @return The the minimum number of times a query must be searched in order to be eligible to suggest to your * users. ** Decreasing this number increases the number of suggestions. However, this affects the quality of * suggestions as it sets a low bar for a query to be considered popular to suggest to users. *
** How you tune this setting depends on your specific needs. */ public Integer getMinimumQueryCount() { return this.minimumQueryCount; } /** *
* The the minimum number of times a query must be searched in order to be eligible to suggest to your users. *
** Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as * it sets a low bar for a query to be considered popular to suggest to users. *
** How you tune this setting depends on your specific needs. *
* * @param minimumQueryCount * The the minimum number of times a query must be searched in order to be eligible to suggest to your * users. ** Decreasing this number increases the number of suggestions. However, this affects the quality of * suggestions as it sets a low bar for a query to be considered popular to suggest to users. *
** How you tune this setting depends on your specific needs. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateQuerySuggestionsConfigRequest withMinimumQueryCount(Integer minimumQueryCount) { setMinimumQueryCount(minimumQueryCount); return this; } /** *
* Configuration information for the document fields/attributes that you want to base query suggestions on. *
* * @param attributeSuggestionsConfig * Configuration information for the document fields/attributes that you want to base query suggestions on. */ public void setAttributeSuggestionsConfig(AttributeSuggestionsUpdateConfig attributeSuggestionsConfig) { this.attributeSuggestionsConfig = attributeSuggestionsConfig; } /** ** Configuration information for the document fields/attributes that you want to base query suggestions on. *
* * @return Configuration information for the document fields/attributes that you want to base query suggestions on. */ public AttributeSuggestionsUpdateConfig getAttributeSuggestionsConfig() { return this.attributeSuggestionsConfig; } /** ** Configuration information for the document fields/attributes that you want to base query suggestions on. *
* * @param attributeSuggestionsConfig * Configuration information for the document fields/attributes that you want to base query suggestions on. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateQuerySuggestionsConfigRequest withAttributeSuggestionsConfig(AttributeSuggestionsUpdateConfig attributeSuggestionsConfig) { setAttributeSuggestionsConfig(attributeSuggestionsConfig); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getIndexId() != null) sb.append("IndexId: ").append(getIndexId()).append(","); if (getMode() != null) sb.append("Mode: ").append(getMode()).append(","); if (getQueryLogLookBackWindowInDays() != null) sb.append("QueryLogLookBackWindowInDays: ").append(getQueryLogLookBackWindowInDays()).append(","); if (getIncludeQueriesWithoutUserInformation() != null) sb.append("IncludeQueriesWithoutUserInformation: ").append(getIncludeQueriesWithoutUserInformation()).append(","); if (getMinimumNumberOfQueryingUsers() != null) sb.append("MinimumNumberOfQueryingUsers: ").append(getMinimumNumberOfQueryingUsers()).append(","); if (getMinimumQueryCount() != null) sb.append("MinimumQueryCount: ").append(getMinimumQueryCount()).append(","); if (getAttributeSuggestionsConfig() != null) sb.append("AttributeSuggestionsConfig: ").append(getAttributeSuggestionsConfig()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdateQuerySuggestionsConfigRequest == false) return false; UpdateQuerySuggestionsConfigRequest other = (UpdateQuerySuggestionsConfigRequest) obj; if (other.getIndexId() == null ^ this.getIndexId() == null) return false; if (other.getIndexId() != null && other.getIndexId().equals(this.getIndexId()) == false) return false; if (other.getMode() == null ^ this.getMode() == null) return false; if (other.getMode() != null && other.getMode().equals(this.getMode()) == false) return false; if (other.getQueryLogLookBackWindowInDays() == null ^ this.getQueryLogLookBackWindowInDays() == null) return false; if (other.getQueryLogLookBackWindowInDays() != null && other.getQueryLogLookBackWindowInDays().equals(this.getQueryLogLookBackWindowInDays()) == false) return false; if (other.getIncludeQueriesWithoutUserInformation() == null ^ this.getIncludeQueriesWithoutUserInformation() == null) return false; if (other.getIncludeQueriesWithoutUserInformation() != null && other.getIncludeQueriesWithoutUserInformation().equals(this.getIncludeQueriesWithoutUserInformation()) == false) return false; if (other.getMinimumNumberOfQueryingUsers() == null ^ this.getMinimumNumberOfQueryingUsers() == null) return false; if (other.getMinimumNumberOfQueryingUsers() != null && other.getMinimumNumberOfQueryingUsers().equals(this.getMinimumNumberOfQueryingUsers()) == false) return false; if (other.getMinimumQueryCount() == null ^ this.getMinimumQueryCount() == null) return false; if (other.getMinimumQueryCount() != null && other.getMinimumQueryCount().equals(this.getMinimumQueryCount()) == false) return false; if (other.getAttributeSuggestionsConfig() == null ^ this.getAttributeSuggestionsConfig() == null) return false; if (other.getAttributeSuggestionsConfig() != null && other.getAttributeSuggestionsConfig().equals(this.getAttributeSuggestionsConfig()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getIndexId() == null) ? 0 : getIndexId().hashCode()); hashCode = prime * hashCode + ((getMode() == null) ? 0 : getMode().hashCode()); hashCode = prime * hashCode + ((getQueryLogLookBackWindowInDays() == null) ? 0 : getQueryLogLookBackWindowInDays().hashCode()); hashCode = prime * hashCode + ((getIncludeQueriesWithoutUserInformation() == null) ? 0 : getIncludeQueriesWithoutUserInformation().hashCode()); hashCode = prime * hashCode + ((getMinimumNumberOfQueryingUsers() == null) ? 0 : getMinimumNumberOfQueryingUsers().hashCode()); hashCode = prime * hashCode + ((getMinimumQueryCount() == null) ? 0 : getMinimumQueryCount().hashCode()); hashCode = prime * hashCode + ((getAttributeSuggestionsConfig() == null) ? 0 : getAttributeSuggestionsConfig().hashCode()); return hashCode; } @Override public UpdateQuerySuggestionsConfigRequest clone() { return (UpdateQuerySuggestionsConfigRequest) super.clone(); } }