/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kendra.model; import java.io.Serializable; import javax.annotation.Generated; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class QueryResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable { /** *

* The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API. *

*/ private String queryId; /** *

* The results of the search. *

*/ private java.util.List resultItems; /** *

* Contains the facet results. A FacetResult contains the counts for each field/attribute key that was * specified in the Facets input parameter. *

*/ private java.util.List facetResults; /** *

* The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if * the search found 192 items, you can only retrieve the first 100 of the items. *

*/ private Integer totalNumberOfResults; /** *

* A list of warning codes and their messages on problems with your query. *

* Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the * query. For examples of invalid query syntax, see Searching * with advanced query syntax. *

*/ private java.util.List warnings; /** *

* A list of information related to suggested spell corrections for a query. *

*/ private java.util.List spellCorrectedQueries; /** *

* The list of featured result items. Featured results are displayed at the top of the search results page, placed * above all other results for certain queries. If there's an exact match of a query, then certain documents are * featured in the search results. *

*/ private java.util.List featuredResultsItems; /** *

* The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API. *

* * @param queryId * The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback * API. */ public void setQueryId(String queryId) { this.queryId = queryId; } /** *

* The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API. *

* * @return The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback * API. */ public String getQueryId() { return this.queryId; } /** *

* The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API. *

* * @param queryId * The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback * API. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withQueryId(String queryId) { setQueryId(queryId); return this; } /** *

* The results of the search. *

* * @return The results of the search. */ public java.util.List getResultItems() { return resultItems; } /** *

* The results of the search. *

* * @param resultItems * The results of the search. */ public void setResultItems(java.util.Collection resultItems) { if (resultItems == null) { this.resultItems = null; return; } this.resultItems = new java.util.ArrayList(resultItems); } /** *

* The results of the search. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setResultItems(java.util.Collection)} or {@link #withResultItems(java.util.Collection)} if you want to * override the existing values. *

* * @param resultItems * The results of the search. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withResultItems(QueryResultItem... resultItems) { if (this.resultItems == null) { setResultItems(new java.util.ArrayList(resultItems.length)); } for (QueryResultItem ele : resultItems) { this.resultItems.add(ele); } return this; } /** *

* The results of the search. *

* Contains the facet results. A FacetResult contains the counts for each field/attribute key that was * specified in the Facets input parameter. *

* * @return Contains the facet results. A FacetResult contains the counts for each field/attribute key * that was specified in the Facets input parameter. */ public java.util.List getFacetResults() { return facetResults; } /** *

* Contains the facet results. A FacetResult contains the counts for each field/attribute key that was * specified in the Facets input parameter. *

* * @param facetResults * Contains the facet results. A FacetResult contains the counts for each field/attribute key * that was specified in the Facets input parameter. */ public void setFacetResults(java.util.Collection facetResults) { if (facetResults == null) { this.facetResults = null; return; } this.facetResults = new java.util.ArrayList(facetResults); } /** *

* Contains the facet results. A FacetResult contains the counts for each field/attribute key that was * specified in the Facets input parameter. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setFacetResults(java.util.Collection)} or {@link #withFacetResults(java.util.Collection)} if you want to * override the existing values. *

* * @param facetResults * Contains the facet results. A FacetResult contains the counts for each field/attribute key * that was specified in the Facets input parameter. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withFacetResults(FacetResult... facetResults) { if (this.facetResults == null) { setFacetResults(new java.util.ArrayList(facetResults.length)); } for (FacetResult ele : facetResults) { this.facetResults.add(ele); } return this; } /** *

* Contains the facet results. A FacetResult contains the counts for each field/attribute key that was * specified in the Facets input parameter. *

* * @param facetResults * Contains the facet results. A FacetResult contains the counts for each field/attribute key * that was specified in the Facets input parameter. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withFacetResults(java.util.Collection facetResults) { setFacetResults(facetResults); return this; } /** *

* The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if * the search found 192 items, you can only retrieve the first 100 of the items. *

* * @param totalNumberOfResults * The total number of items found by the search. However, you can only retrieve up to 100 items. For * example, if the search found 192 items, you can only retrieve the first 100 of the items. */ public void setTotalNumberOfResults(Integer totalNumberOfResults) { this.totalNumberOfResults = totalNumberOfResults; } /** *

* The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if * the search found 192 items, you can only retrieve the first 100 of the items. *

* * @return The total number of items found by the search. However, you can only retrieve up to 100 items. For * example, if the search found 192 items, you can only retrieve the first 100 of the items. */ public Integer getTotalNumberOfResults() { return this.totalNumberOfResults; } /** *

* The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if * the search found 192 items, you can only retrieve the first 100 of the items. *

* * @param totalNumberOfResults * The total number of items found by the search. However, you can only retrieve up to 100 items. For * example, if the search found 192 items, you can only retrieve the first 100 of the items. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withTotalNumberOfResults(Integer totalNumberOfResults) { setTotalNumberOfResults(totalNumberOfResults); return this; } /** *

* A list of warning codes and their messages on problems with your query. *

* * @return A list of warning codes and their messages on problems with your query.

* A list of warning codes and their messages on problems with your query. *

* * @param warnings * A list of warning codes and their messages on problems with your query.

* Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in * the query. For examples of invalid query syntax, see Searching with advanced query syntax. */ public void setWarnings(java.util.Collection warnings) { if (warnings == null) { this.warnings = null; return; } this.warnings = new java.util.ArrayList(warnings); } /** *

* A list of warning codes and their messages on problems with your query. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setWarnings(java.util.Collection)} or {@link #withWarnings(java.util.Collection)} if you want to override * the existing values. *

* * @param warnings * A list of warning codes and their messages on problems with your query.

* Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in * the query. For examples of invalid query syntax, see Searching with advanced query syntax. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withWarnings(Warning... warnings) { if (this.warnings == null) { setWarnings(new java.util.ArrayList(warnings.length)); } for (Warning ele : warnings) { this.warnings.add(ele); } return this; } /** *

* A list of warning codes and their messages on problems with your query. *

* * @param warnings * A list of warning codes and their messages on problems with your query.

* Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in * the query. For examples of invalid query syntax, see Searching with advanced query syntax. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withWarnings(java.util.Collection warnings) { setWarnings(warnings); return this; } /** *

* A list of information related to suggested spell corrections for a query. *

* * @return A list of information related to suggested spell corrections for a query. */ public java.util.List getSpellCorrectedQueries() { return spellCorrectedQueries; } /** *

* A list of information related to suggested spell corrections for a query. *

* * @param spellCorrectedQueries * A list of information related to suggested spell corrections for a query. */ public void setSpellCorrectedQueries(java.util.Collection spellCorrectedQueries) { if (spellCorrectedQueries == null) { this.spellCorrectedQueries = null; return; } this.spellCorrectedQueries = new java.util.ArrayList(spellCorrectedQueries); } /** *

* A list of information related to suggested spell corrections for a query. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSpellCorrectedQueries(java.util.Collection)} or * {@link #withSpellCorrectedQueries(java.util.Collection)} if you want to override the existing values. *

* * @param spellCorrectedQueries * A list of information related to suggested spell corrections for a query. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withSpellCorrectedQueries(SpellCorrectedQuery... spellCorrectedQueries) { if (this.spellCorrectedQueries == null) { setSpellCorrectedQueries(new java.util.ArrayList(spellCorrectedQueries.length)); } for (SpellCorrectedQuery ele : spellCorrectedQueries) { this.spellCorrectedQueries.add(ele); } return this; } /** *

* A list of information related to suggested spell corrections for a query. *

* * @return The list of featured result items. Featured results are displayed at the top of the search results page, * placed above all other results for certain queries. If there's an exact match of a query, then certain * documents are featured in the search results. */ public java.util.List getFeaturedResultsItems() { return featuredResultsItems; } /** *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setFeaturedResultsItems(java.util.Collection)} or {@link #withFeaturedResultsItems(java.util.Collection)} * if you want to override the existing values. *

* * @param featuredResultsItems * The list of featured result items. Featured results are displayed at the top of the search results page, * placed above all other results for certain queries. If there's an exact match of a query, then certain * documents are featured in the search results. * @return Returns a reference to this object so that method calls can be chained together. */ public QueryResult withFeaturedResultsItems(java.util.Collection featuredResultsItems) { setFeaturedResultsItems(featuredResultsItems); 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 (getQueryId() != null) sb.append("QueryId: ").append(getQueryId()).append(","); if (getResultItems() != null) sb.append("ResultItems: ").append(getResultItems()).append(","); if (getFacetResults() != null) sb.append("FacetResults: ").append(getFacetResults()).append(","); if (getTotalNumberOfResults() != null) sb.append("TotalNumberOfResults: ").append(getTotalNumberOfResults()).append(","); if (getWarnings() != null) sb.append("Warnings: ").append(getWarnings()).append(","); if (getSpellCorrectedQueries() != null) sb.append("SpellCorrectedQueries: ").append(getSpellCorrectedQueries()).append(","); if (getFeaturedResultsItems() != null) sb.append("FeaturedResultsItems: ").append(getFeaturedResultsItems()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof QueryResult == false) return false; QueryResult other = (QueryResult) obj; if (other.getQueryId() == null ^ this.getQueryId() == null) return false; if (other.getQueryId() != null && other.getQueryId().equals(this.getQueryId()) == false) return false; if (other.getResultItems() == null ^ this.getResultItems() == null) return false; if (other.getResultItems() != null && other.getResultItems().equals(this.getResultItems()) == false) return false; if (other.getFacetResults() == null ^ this.getFacetResults() == null) return false; if (other.getFacetResults() != null && other.getFacetResults().equals(this.getFacetResults()) == false) return false; if (other.getTotalNumberOfResults() == null ^ this.getTotalNumberOfResults() == null) return false; if (other.getTotalNumberOfResults() != null && other.getTotalNumberOfResults().equals(this.getTotalNumberOfResults()) == false) return false; if (other.getWarnings() == null ^ this.getWarnings() == null) return false; if (other.getWarnings() != null && other.getWarnings().equals(this.getWarnings()) == false) return false; if (other.getSpellCorrectedQueries() == null ^ this.getSpellCorrectedQueries() == null) return false; if (other.getSpellCorrectedQueries() != null && other.getSpellCorrectedQueries().equals(this.getSpellCorrectedQueries()) == false) return false; if (other.getFeaturedResultsItems() == null ^ this.getFeaturedResultsItems() == null) return false; if (other.getFeaturedResultsItems() != null && other.getFeaturedResultsItems().equals(this.getFeaturedResultsItems()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getQueryId() == null) ? 0 : getQueryId().hashCode()); hashCode = prime * hashCode + ((getResultItems() == null) ? 0 : getResultItems().hashCode()); hashCode = prime * hashCode + ((getFacetResults() == null) ? 0 : getFacetResults().hashCode()); hashCode = prime * hashCode + ((getTotalNumberOfResults() == null) ? 0 : getTotalNumberOfResults().hashCode()); hashCode = prime * hashCode + ((getWarnings() == null) ? 0 : getWarnings().hashCode()); hashCode = prime * hashCode + ((getSpellCorrectedQueries() == null) ? 0 : getSpellCorrectedQueries().hashCode()); hashCode = prime * hashCode + ((getFeaturedResultsItems() == null) ? 0 : getFeaturedResultsItems().hashCode()); return hashCode; } @Override public QueryResult clone() { try { return (QueryResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }