com.amazonaws.services.qconnect.model.QueryAssistantRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-qconnect 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.qconnect.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class QueryAssistantRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*/
private String assistantId;
/**
*
* The maximum number of results to return per page.
*
*/
private Integer maxResults;
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*/
private String nextToken;
/**
*
* Information about how to query content.
*
*/
private java.util.List queryCondition;
/**
*
* The text to search for.
*
*/
private String queryText;
/**
*
* The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*/
private String sessionId;
/**
*
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param assistantId
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
public void setAssistantId(String assistantId) {
this.assistantId = assistantId;
}
/**
*
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @return The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
public String getAssistantId() {
return this.assistantId;
}
/**
*
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param assistantId
* The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QueryAssistantRequest withAssistantId(String assistantId) {
setAssistantId(assistantId);
return this;
}
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QueryAssistantRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* @param nextToken
* The token for the next set of results. Use the value returned in the previous response in the next request
* to retrieve the next set of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* @return The token for the next set of results. Use the value returned in the previous response in the next
* request to retrieve the next set of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* @param nextToken
* The token for the next set of results. Use the value returned in the previous response in the next request
* to retrieve the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QueryAssistantRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Information about how to query content.
*
*
* @return Information about how to query content.
*/
public java.util.List getQueryCondition() {
return queryCondition;
}
/**
*
* Information about how to query content.
*
*
* @param queryCondition
* Information about how to query content.
*/
public void setQueryCondition(java.util.Collection queryCondition) {
if (queryCondition == null) {
this.queryCondition = null;
return;
}
this.queryCondition = new java.util.ArrayList(queryCondition);
}
/**
*
* Information about how to query content.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setQueryCondition(java.util.Collection)} or {@link #withQueryCondition(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param queryCondition
* Information about how to query content.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QueryAssistantRequest withQueryCondition(QueryCondition... queryCondition) {
if (this.queryCondition == null) {
setQueryCondition(new java.util.ArrayList(queryCondition.length));
}
for (QueryCondition ele : queryCondition) {
this.queryCondition.add(ele);
}
return this;
}
/**
*
* Information about how to query content.
*
*
* @param queryCondition
* Information about how to query content.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QueryAssistantRequest withQueryCondition(java.util.Collection queryCondition) {
setQueryCondition(queryCondition);
return this;
}
/**
*
* The text to search for.
*
*
* @param queryText
* The text to search for.
*/
public void setQueryText(String queryText) {
this.queryText = queryText;
}
/**
*
* The text to search for.
*
*
* @return The text to search for.
*/
public String getQueryText() {
return this.queryText;
}
/**
*
* The text to search for.
*
*
* @param queryText
* The text to search for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QueryAssistantRequest withQueryText(String queryText) {
setQueryText(queryText);
return this;
}
/**
*
* The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param sessionId
* The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
public void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
/**
*
* The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @return The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
public String getSessionId() {
return this.sessionId;
}
/**
*
* The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param sessionId
* The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QueryAssistantRequest withSessionId(String sessionId) {
setSessionId(sessionId);
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 (getAssistantId() != null)
sb.append("AssistantId: ").append(getAssistantId()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getQueryCondition() != null)
sb.append("QueryCondition: ").append(getQueryCondition()).append(",");
if (getQueryText() != null)
sb.append("QueryText: ").append("***Sensitive Data Redacted***").append(",");
if (getSessionId() != null)
sb.append("SessionId: ").append(getSessionId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof QueryAssistantRequest == false)
return false;
QueryAssistantRequest other = (QueryAssistantRequest) obj;
if (other.getAssistantId() == null ^ this.getAssistantId() == null)
return false;
if (other.getAssistantId() != null && other.getAssistantId().equals(this.getAssistantId()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getQueryCondition() == null ^ this.getQueryCondition() == null)
return false;
if (other.getQueryCondition() != null && other.getQueryCondition().equals(this.getQueryCondition()) == false)
return false;
if (other.getQueryText() == null ^ this.getQueryText() == null)
return false;
if (other.getQueryText() != null && other.getQueryText().equals(this.getQueryText()) == false)
return false;
if (other.getSessionId() == null ^ this.getSessionId() == null)
return false;
if (other.getSessionId() != null && other.getSessionId().equals(this.getSessionId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAssistantId() == null) ? 0 : getAssistantId().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getQueryCondition() == null) ? 0 : getQueryCondition().hashCode());
hashCode = prime * hashCode + ((getQueryText() == null) ? 0 : getQueryText().hashCode());
hashCode = prime * hashCode + ((getSessionId() == null) ? 0 : getSessionId().hashCode());
return hashCode;
}
@Override
public QueryAssistantRequest clone() {
return (QueryAssistantRequest) super.clone();
}
}