com.amazonaws.services.kendra.model.Suggestion 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A single query suggestion.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Suggestion implements Serializable, Cloneable, StructuredPojo {
/**
*
* The UUID (universally unique identifier) of a single query suggestion.
*
*/
private String id;
/**
*
* The value for the UUID (universally unique identifier) of a single query suggestion.
*
*
* The value is the text string of a suggestion.
*
*/
private SuggestionValue value;
/**
*
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if document
* fields set to use for query suggestions.
*
*/
private java.util.List sourceDocuments;
/**
*
* The UUID (universally unique identifier) of a single query suggestion.
*
*
* @param id
* The UUID (universally unique identifier) of a single query suggestion.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The UUID (universally unique identifier) of a single query suggestion.
*
*
* @return The UUID (universally unique identifier) of a single query suggestion.
*/
public String getId() {
return this.id;
}
/**
*
* The UUID (universally unique identifier) of a single query suggestion.
*
*
* @param id
* The UUID (universally unique identifier) of a single query suggestion.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Suggestion withId(String id) {
setId(id);
return this;
}
/**
*
* The value for the UUID (universally unique identifier) of a single query suggestion.
*
*
* The value is the text string of a suggestion.
*
*
* @param value
* The value for the UUID (universally unique identifier) of a single query suggestion.
*
* The value is the text string of a suggestion.
*/
public void setValue(SuggestionValue value) {
this.value = value;
}
/**
*
* The value for the UUID (universally unique identifier) of a single query suggestion.
*
*
* The value is the text string of a suggestion.
*
*
* @return The value for the UUID (universally unique identifier) of a single query suggestion.
*
* The value is the text string of a suggestion.
*/
public SuggestionValue getValue() {
return this.value;
}
/**
*
* The value for the UUID (universally unique identifier) of a single query suggestion.
*
*
* The value is the text string of a suggestion.
*
*
* @param value
* The value for the UUID (universally unique identifier) of a single query suggestion.
*
* The value is the text string of a suggestion.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Suggestion withValue(SuggestionValue value) {
setValue(value);
return this;
}
/**
*
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if document
* fields set to use for query suggestions.
*
*
* @return The list of document IDs and their fields/attributes that are used for a single query suggestion, if
* document fields set to use for query suggestions.
*/
public java.util.List getSourceDocuments() {
return sourceDocuments;
}
/**
*
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if document
* fields set to use for query suggestions.
*
*
* @param sourceDocuments
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if
* document fields set to use for query suggestions.
*/
public void setSourceDocuments(java.util.Collection sourceDocuments) {
if (sourceDocuments == null) {
this.sourceDocuments = null;
return;
}
this.sourceDocuments = new java.util.ArrayList(sourceDocuments);
}
/**
*
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if document
* fields set to use for query suggestions.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSourceDocuments(java.util.Collection)} or {@link #withSourceDocuments(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param sourceDocuments
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if
* document fields set to use for query suggestions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Suggestion withSourceDocuments(SourceDocument... sourceDocuments) {
if (this.sourceDocuments == null) {
setSourceDocuments(new java.util.ArrayList(sourceDocuments.length));
}
for (SourceDocument ele : sourceDocuments) {
this.sourceDocuments.add(ele);
}
return this;
}
/**
*
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if document
* fields set to use for query suggestions.
*
*
* @param sourceDocuments
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if
* document fields set to use for query suggestions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Suggestion withSourceDocuments(java.util.Collection sourceDocuments) {
setSourceDocuments(sourceDocuments);
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 (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getSourceDocuments() != null)
sb.append("SourceDocuments: ").append(getSourceDocuments());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Suggestion == false)
return false;
Suggestion other = (Suggestion) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getSourceDocuments() == null ^ this.getSourceDocuments() == null)
return false;
if (other.getSourceDocuments() != null && other.getSourceDocuments().equals(this.getSourceDocuments()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getSourceDocuments() == null) ? 0 : getSourceDocuments().hashCode());
return hashCode;
}
@Override
public Suggestion clone() {
try {
return (Suggestion) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kendra.model.transform.SuggestionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}