com.amazonaws.services.kendra.model.CreateFeaturedResultsSetRequest 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.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateFeaturedResultsSetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the index that you want to use for featuring results.
*
*/
private String indexId;
/**
*
* A name for the set of featured results.
*
*/
private String featuredResultsSetName;
/**
*
* A description for the set of featured results.
*
*/
private String description;
/**
*
* A token that you provide to identify the request to create a set of featured results. Multiple calls to the
* CreateFeaturedResultsSet API with the same client token will create only one featured results set.
*
*/
private String clientToken;
/**
*
* The current status of the set of featured results. When the value is ACTIVE, featured results are
* ready for use. You can still configure your settings before setting the status to ACTIVE. You can
* set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
* results set for each index, whether the status is ACTIVE or INACTIVE.
*
*/
private String status;
/**
*
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*
*/
private java.util.List queryTexts;
/**
*
* A list of document IDs for the documents you want to feature at the top of the search results page. For more
* information on the list of documents, see FeaturedResultsSet.
*
*/
private java.util.List featuredDocuments;
/**
*
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help
* control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols:_ . : / = + - @.
*
*/
private java.util.List tags;
/**
*
* The identifier of the index that you want to use for featuring results.
*
*
* @param indexId
* The identifier of the index that you want to use for featuring results.
*/
public void setIndexId(String indexId) {
this.indexId = indexId;
}
/**
*
* The identifier of the index that you want to use for featuring results.
*
*
* @return The identifier of the index that you want to use for featuring results.
*/
public String getIndexId() {
return this.indexId;
}
/**
*
* The identifier of the index that you want to use for featuring results.
*
*
* @param indexId
* The identifier of the index that you want to use for featuring results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withIndexId(String indexId) {
setIndexId(indexId);
return this;
}
/**
*
* A name for the set of featured results.
*
*
* @param featuredResultsSetName
* A name for the set of featured results.
*/
public void setFeaturedResultsSetName(String featuredResultsSetName) {
this.featuredResultsSetName = featuredResultsSetName;
}
/**
*
* A name for the set of featured results.
*
*
* @return A name for the set of featured results.
*/
public String getFeaturedResultsSetName() {
return this.featuredResultsSetName;
}
/**
*
* A name for the set of featured results.
*
*
* @param featuredResultsSetName
* A name for the set of featured results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withFeaturedResultsSetName(String featuredResultsSetName) {
setFeaturedResultsSetName(featuredResultsSetName);
return this;
}
/**
*
* A description for the set of featured results.
*
*
* @param description
* A description for the set of featured results.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description for the set of featured results.
*
*
* @return A description for the set of featured results.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description for the set of featured results.
*
*
* @param description
* A description for the set of featured results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* A token that you provide to identify the request to create a set of featured results. Multiple calls to the
* CreateFeaturedResultsSet API with the same client token will create only one featured results set.
*
*
* @param clientToken
* A token that you provide to identify the request to create a set of featured results. Multiple calls to
* the CreateFeaturedResultsSet API with the same client token will create only one featured
* results set.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A token that you provide to identify the request to create a set of featured results. Multiple calls to the
* CreateFeaturedResultsSet API with the same client token will create only one featured results set.
*
*
* @return A token that you provide to identify the request to create a set of featured results. Multiple calls to
* the CreateFeaturedResultsSet API with the same client token will create only one featured
* results set.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A token that you provide to identify the request to create a set of featured results. Multiple calls to the
* CreateFeaturedResultsSet API with the same client token will create only one featured results set.
*
*
* @param clientToken
* A token that you provide to identify the request to create a set of featured results. Multiple calls to
* the CreateFeaturedResultsSet API with the same client token will create only one featured
* results set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The current status of the set of featured results. When the value is ACTIVE, featured results are
* ready for use. You can still configure your settings before setting the status to ACTIVE. You can
* set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
* results set for each index, whether the status is ACTIVE or INACTIVE.
*
*
* @param status
* The current status of the set of featured results. When the value is ACTIVE, featured results
* are ready for use. You can still configure your settings before setting the status to ACTIVE.
* You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
* featured results set for each index, whether the status is ACTIVE or INACTIVE.
* @see FeaturedResultsSetStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The current status of the set of featured results. When the value is ACTIVE, featured results are
* ready for use. You can still configure your settings before setting the status to ACTIVE. You can
* set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
* results set for each index, whether the status is ACTIVE or INACTIVE.
*
*
* @return The current status of the set of featured results. When the value is ACTIVE, featured
* results are ready for use. You can still configure your settings before setting the status to
* ACTIVE. You can set the status to ACTIVE or INACTIVE using the
* UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
* featured results set for each index, whether the status is ACTIVE or INACTIVE.
* @see FeaturedResultsSetStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The current status of the set of featured results. When the value is ACTIVE, featured results are
* ready for use. You can still configure your settings before setting the status to ACTIVE. You can
* set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
* results set for each index, whether the status is ACTIVE or INACTIVE.
*
*
* @param status
* The current status of the set of featured results. When the value is ACTIVE, featured results
* are ready for use. You can still configure your settings before setting the status to ACTIVE.
* You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
* featured results set for each index, whether the status is ACTIVE or INACTIVE.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FeaturedResultsSetStatus
*/
public CreateFeaturedResultsSetRequest withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The current status of the set of featured results. When the value is ACTIVE, featured results are
* ready for use. You can still configure your settings before setting the status to ACTIVE. You can
* set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
* results set for each index, whether the status is ACTIVE or INACTIVE.
*
*
* @param status
* The current status of the set of featured results. When the value is ACTIVE, featured results
* are ready for use. You can still configure your settings before setting the status to ACTIVE.
* You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
* featured results set for each index, whether the status is ACTIVE or INACTIVE.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FeaturedResultsSetStatus
*/
public CreateFeaturedResultsSetRequest withStatus(FeaturedResultsSetStatus status) {
this.status = status.toString();
return this;
}
/**
*
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*
*
* @return A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*/
public java.util.List getQueryTexts() {
return queryTexts;
}
/**
*
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*
*
* @param queryTexts
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*/
public void setQueryTexts(java.util.Collection queryTexts) {
if (queryTexts == null) {
this.queryTexts = null;
return;
}
this.queryTexts = new java.util.ArrayList(queryTexts);
}
/**
*
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setQueryTexts(java.util.Collection)} or {@link #withQueryTexts(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param queryTexts
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withQueryTexts(String... queryTexts) {
if (this.queryTexts == null) {
setQueryTexts(new java.util.ArrayList(queryTexts.length));
}
for (String ele : queryTexts) {
this.queryTexts.add(ele);
}
return this;
}
/**
*
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
*
*
* @param queryTexts
* A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withQueryTexts(java.util.Collection queryTexts) {
setQueryTexts(queryTexts);
return this;
}
/**
*
* A list of document IDs for the documents you want to feature at the top of the search results page. For more
* information on the list of documents, see FeaturedResultsSet.
*
*
* @return A list of document IDs for the documents you want to feature at the top of the search results page. For
* more information on the list of documents, see FeaturedResultsSet.
*/
public java.util.List getFeaturedDocuments() {
return featuredDocuments;
}
/**
*
* A list of document IDs for the documents you want to feature at the top of the search results page. For more
* information on the list of documents, see FeaturedResultsSet.
*
*
* @param featuredDocuments
* A list of document IDs for the documents you want to feature at the top of the search results page. For
* more information on the list of documents, see FeaturedResultsSet.
*/
public void setFeaturedDocuments(java.util.Collection featuredDocuments) {
if (featuredDocuments == null) {
this.featuredDocuments = null;
return;
}
this.featuredDocuments = new java.util.ArrayList(featuredDocuments);
}
/**
*
* A list of document IDs for the documents you want to feature at the top of the search results page. For more
* information on the list of documents, see FeaturedResultsSet.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFeaturedDocuments(java.util.Collection)} or {@link #withFeaturedDocuments(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param featuredDocuments
* A list of document IDs for the documents you want to feature at the top of the search results page. For
* more information on the list of documents, see FeaturedResultsSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withFeaturedDocuments(FeaturedDocument... featuredDocuments) {
if (this.featuredDocuments == null) {
setFeaturedDocuments(new java.util.ArrayList(featuredDocuments.length));
}
for (FeaturedDocument ele : featuredDocuments) {
this.featuredDocuments.add(ele);
}
return this;
}
/**
*
* A list of document IDs for the documents you want to feature at the top of the search results page. For more
* information on the list of documents, see FeaturedResultsSet.
*
*
* @param featuredDocuments
* A list of document IDs for the documents you want to feature at the top of the search results page. For
* more information on the list of documents, see FeaturedResultsSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withFeaturedDocuments(java.util.Collection featuredDocuments) {
setFeaturedDocuments(featuredDocuments);
return this;
}
/**
*
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help
* control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols:_ . : / = + - @.
*
*
* @return A list of key-value pairs that identify or categorize the featured results set. You can also use tags to
* help control access to the featured results set. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols:_ . : / = + - @.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help
* control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols:_ . : / = + - @.
*
*
* @param tags
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to
* help control access to the featured results set. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols:_ . : / = + - @.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help
* control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols:_ . : / = + - @.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to
* help control access to the featured results set. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols:_ . : / = + - @.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help
* control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white
* space, and any of the following symbols:_ . : / = + - @.
*
*
* @param tags
* A list of key-value pairs that identify or categorize the featured results set. You can also use tags to
* help control access to the featured results set. Tag keys and values can consist of Unicode letters,
* digits, white space, and any of the following symbols:_ . : / = + - @.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFeaturedResultsSetRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getFeaturedResultsSetName() != null)
sb.append("FeaturedResultsSetName: ").append(getFeaturedResultsSetName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getQueryTexts() != null)
sb.append("QueryTexts: ").append(getQueryTexts()).append(",");
if (getFeaturedDocuments() != null)
sb.append("FeaturedDocuments: ").append(getFeaturedDocuments()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateFeaturedResultsSetRequest == false)
return false;
CreateFeaturedResultsSetRequest other = (CreateFeaturedResultsSetRequest) obj;
if (other.getIndexId() == null ^ this.getIndexId() == null)
return false;
if (other.getIndexId() != null && other.getIndexId().equals(this.getIndexId()) == false)
return false;
if (other.getFeaturedResultsSetName() == null ^ this.getFeaturedResultsSetName() == null)
return false;
if (other.getFeaturedResultsSetName() != null && other.getFeaturedResultsSetName().equals(this.getFeaturedResultsSetName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getQueryTexts() == null ^ this.getQueryTexts() == null)
return false;
if (other.getQueryTexts() != null && other.getQueryTexts().equals(this.getQueryTexts()) == false)
return false;
if (other.getFeaturedDocuments() == null ^ this.getFeaturedDocuments() == null)
return false;
if (other.getFeaturedDocuments() != null && other.getFeaturedDocuments().equals(this.getFeaturedDocuments()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == 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 + ((getFeaturedResultsSetName() == null) ? 0 : getFeaturedResultsSetName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getQueryTexts() == null) ? 0 : getQueryTexts().hashCode());
hashCode = prime * hashCode + ((getFeaturedDocuments() == null) ? 0 : getFeaturedDocuments().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateFeaturedResultsSetRequest clone() {
return (CreateFeaturedResultsSetRequest) super.clone();
}
}