com.amazonaws.services.kendra.model.Search Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2015-2020 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;
/**
*
* Provides information about how a custom index field is used during a search.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Search implements Serializable, Cloneable, StructuredPojo {
/**
*
* Indicates that the field can be used to create search facets, a count of results for each value in the field. The
* default is false .
*
*/
private Boolean facetable;
/**
*
* Determines whether the field is used in the search. If the Searchable field is true,
* you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
* true for string fields and false for number and date fields.
*
*/
private Boolean searchable;
/**
*
* Determines whether the field is returned in the query response. The default is true.
*
*/
private Boolean displayable;
/**
*
* Indicates that the field can be used to create search facets, a count of results for each value in the field. The
* default is false .
*
*
* @param facetable
* Indicates that the field can be used to create search facets, a count of results for each value in the
* field. The default is false .
*/
public void setFacetable(Boolean facetable) {
this.facetable = facetable;
}
/**
*
* Indicates that the field can be used to create search facets, a count of results for each value in the field. The
* default is false .
*
*
* @return Indicates that the field can be used to create search facets, a count of results for each value in the
* field. The default is false .
*/
public Boolean getFacetable() {
return this.facetable;
}
/**
*
* Indicates that the field can be used to create search facets, a count of results for each value in the field. The
* default is false .
*
*
* @param facetable
* Indicates that the field can be used to create search facets, a count of results for each value in the
* field. The default is false .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Search withFacetable(Boolean facetable) {
setFacetable(facetable);
return this;
}
/**
*
* Indicates that the field can be used to create search facets, a count of results for each value in the field. The
* default is false .
*
*
* @return Indicates that the field can be used to create search facets, a count of results for each value in the
* field. The default is false .
*/
public Boolean isFacetable() {
return this.facetable;
}
/**
*
* Determines whether the field is used in the search. If the Searchable field is true,
* you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
* true for string fields and false for number and date fields.
*
*
* @param searchable
* Determines whether the field is used in the search. If the Searchable field is
* true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
* the search. The default is true for string fields and false for number and date
* fields.
*/
public void setSearchable(Boolean searchable) {
this.searchable = searchable;
}
/**
*
* Determines whether the field is used in the search. If the Searchable field is true,
* you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
* true for string fields and false for number and date fields.
*
*
* @return Determines whether the field is used in the search. If the Searchable field is
* true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
* the search. The default is true for string fields and false for number and date
* fields.
*/
public Boolean getSearchable() {
return this.searchable;
}
/**
*
* Determines whether the field is used in the search. If the Searchable field is true,
* you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
* true for string fields and false for number and date fields.
*
*
* @param searchable
* Determines whether the field is used in the search. If the Searchable field is
* true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
* the search. The default is true for string fields and false for number and date
* fields.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Search withSearchable(Boolean searchable) {
setSearchable(searchable);
return this;
}
/**
*
* Determines whether the field is used in the search. If the Searchable field is true,
* you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
* true for string fields and false for number and date fields.
*
*
* @return Determines whether the field is used in the search. If the Searchable field is
* true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
* the search. The default is true for string fields and false for number and date
* fields.
*/
public Boolean isSearchable() {
return this.searchable;
}
/**
*
* Determines whether the field is returned in the query response. The default is true.
*
*
* @param displayable
* Determines whether the field is returned in the query response. The default is true.
*/
public void setDisplayable(Boolean displayable) {
this.displayable = displayable;
}
/**
*
* Determines whether the field is returned in the query response. The default is true.
*
*
* @return Determines whether the field is returned in the query response. The default is true.
*/
public Boolean getDisplayable() {
return this.displayable;
}
/**
*
* Determines whether the field is returned in the query response. The default is true.
*
*
* @param displayable
* Determines whether the field is returned in the query response. The default is true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Search withDisplayable(Boolean displayable) {
setDisplayable(displayable);
return this;
}
/**
*
* Determines whether the field is returned in the query response. The default is true.
*
*
* @return Determines whether the field is returned in the query response. The default is true.
*/
public Boolean isDisplayable() {
return this.displayable;
}
/**
* 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 (getFacetable() != null)
sb.append("Facetable: ").append(getFacetable()).append(",");
if (getSearchable() != null)
sb.append("Searchable: ").append(getSearchable()).append(",");
if (getDisplayable() != null)
sb.append("Displayable: ").append(getDisplayable());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Search == false)
return false;
Search other = (Search) obj;
if (other.getFacetable() == null ^ this.getFacetable() == null)
return false;
if (other.getFacetable() != null && other.getFacetable().equals(this.getFacetable()) == false)
return false;
if (other.getSearchable() == null ^ this.getSearchable() == null)
return false;
if (other.getSearchable() != null && other.getSearchable().equals(this.getSearchable()) == false)
return false;
if (other.getDisplayable() == null ^ this.getDisplayable() == null)
return false;
if (other.getDisplayable() != null && other.getDisplayable().equals(this.getDisplayable()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFacetable() == null) ? 0 : getFacetable().hashCode());
hashCode = prime * hashCode + ((getSearchable() == null) ? 0 : getSearchable().hashCode());
hashCode = prime * hashCode + ((getDisplayable() == null) ? 0 : getDisplayable().hashCode());
return hashCode;
}
@Override
public Search clone() {
try {
return (Search) 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.SearchMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}