com.amazonaws.services.kendra.model.RetrieveResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 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 RetrieveResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The identifier of query used for the search. You also use QueryId to identify the search when using
* the Submitfeedback
* API.
*
*/
private String queryId;
/**
*
* The results of the retrieved relevant passages for the search.
*
*/
private java.util.List resultItems;
/**
*
* The identifier of query used for the search. You also use QueryId to identify the search when using
* the Submitfeedback
* API.
*
*
* @param queryId
* The identifier of query used 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 of query used for the search. You also use QueryId to identify the search when using
* the Submitfeedback
* API.
*
*
* @return The identifier of query used for the search. You also use QueryId to identify the search
* when using the Submitfeedback
* API.
*/
public String getQueryId() {
return this.queryId;
}
/**
*
* The identifier of query used for the search. You also use QueryId to identify the search when using
* the Submitfeedback
* API.
*
*
* @param queryId
* The identifier of query used 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 RetrieveResult withQueryId(String queryId) {
setQueryId(queryId);
return this;
}
/**
*
* The results of the retrieved relevant passages for the search.
*
*
* @return The results of the retrieved relevant passages for the search.
*/
public java.util.List getResultItems() {
return resultItems;
}
/**
*
* The results of the retrieved relevant passages for the search.
*
*
* @param resultItems
* The results of the retrieved relevant passages for 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 retrieved relevant passages for 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 retrieved relevant passages for the search.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetrieveResult withResultItems(RetrieveResultItem... resultItems) {
if (this.resultItems == null) {
setResultItems(new java.util.ArrayList(resultItems.length));
}
for (RetrieveResultItem ele : resultItems) {
this.resultItems.add(ele);
}
return this;
}
/**
*
* The results of the retrieved relevant passages for the search.
*
*
* @param resultItems
* The results of the retrieved relevant passages for the search.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetrieveResult withResultItems(java.util.Collection resultItems) {
setResultItems(resultItems);
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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RetrieveResult == false)
return false;
RetrieveResult other = (RetrieveResult) 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;
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());
return hashCode;
}
@Override
public RetrieveResult clone() {
try {
return (RetrieveResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}