com.amazonaws.services.cloudsearchv2.model.TextOptions Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.cloudsearchv2.model;
import java.io.Serializable;
/**
*
* Options for text field. Present if IndexFieldType
* specifies the field is of type text . A text
* field is always searchable. All options are enabled by default.
*
*/
public class TextOptions implements Serializable {
/**
* A value to use for the field if the field isn't specified for a
* document.
*
* Constraints:
* Length: 0 - 1024
*/
private String defaultValue;
/**
* A string that represents the name of an index field. Field names begin
* with a letter and can contain the following characters: a-z
* (lowercase), 0-9, and _ (underscore). The name "score" is reserved and
* cannot be used as a field name. To reference a document's ID, you can
* use the name _id.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-z][a-z0-9_]*
*/
private String sourceField;
/**
* Whether the contents of the field can be returned in the search
* results.
*/
private Boolean returnEnabled;
/**
* Whether the field can be used to sort the search results.
*/
private Boolean sortEnabled;
/**
* Whether highlights can be returned for the field.
*/
private Boolean highlightEnabled;
/**
* The name of an analysis scheme for a text field.
*
* Constraints:
* Pattern: [\S]+
*/
private String analysisScheme;
/**
* A value to use for the field if the field isn't specified for a
* document.
*
* Constraints:
* Length: 0 - 1024
*
* @return A value to use for the field if the field isn't specified for a
* document.
*/
public String getDefaultValue() {
return defaultValue;
}
/**
* A value to use for the field if the field isn't specified for a
* document.
*
* Constraints:
* Length: 0 - 1024
*
* @param defaultValue A value to use for the field if the field isn't specified for a
* document.
*/
public void setDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
}
/**
* A value to use for the field if the field isn't specified for a
* document.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 1024
*
* @param defaultValue A value to use for the field if the field isn't specified for a
* document.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TextOptions withDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
return this;
}
/**
* A string that represents the name of an index field. Field names begin
* with a letter and can contain the following characters: a-z
* (lowercase), 0-9, and _ (underscore). The name "score" is reserved and
* cannot be used as a field name. To reference a document's ID, you can
* use the name _id.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-z][a-z0-9_]*
*
* @return A string that represents the name of an index field. Field names begin
* with a letter and can contain the following characters: a-z
* (lowercase), 0-9, and _ (underscore). The name "score" is reserved and
* cannot be used as a field name. To reference a document's ID, you can
* use the name _id.
*/
public String getSourceField() {
return sourceField;
}
/**
* A string that represents the name of an index field. Field names begin
* with a letter and can contain the following characters: a-z
* (lowercase), 0-9, and _ (underscore). The name "score" is reserved and
* cannot be used as a field name. To reference a document's ID, you can
* use the name _id.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-z][a-z0-9_]*
*
* @param sourceField A string that represents the name of an index field. Field names begin
* with a letter and can contain the following characters: a-z
* (lowercase), 0-9, and _ (underscore). The name "score" is reserved and
* cannot be used as a field name. To reference a document's ID, you can
* use the name _id.
*/
public void setSourceField(String sourceField) {
this.sourceField = sourceField;
}
/**
* A string that represents the name of an index field. Field names begin
* with a letter and can contain the following characters: a-z
* (lowercase), 0-9, and _ (underscore). The name "score" is reserved and
* cannot be used as a field name. To reference a document's ID, you can
* use the name _id.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-z][a-z0-9_]*
*
* @param sourceField A string that represents the name of an index field. Field names begin
* with a letter and can contain the following characters: a-z
* (lowercase), 0-9, and _ (underscore). The name "score" is reserved and
* cannot be used as a field name. To reference a document's ID, you can
* use the name _id.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TextOptions withSourceField(String sourceField) {
this.sourceField = sourceField;
return this;
}
/**
* Whether the contents of the field can be returned in the search
* results.
*
* @return Whether the contents of the field can be returned in the search
* results.
*/
public Boolean isReturnEnabled() {
return returnEnabled;
}
/**
* Whether the contents of the field can be returned in the search
* results.
*
* @param returnEnabled Whether the contents of the field can be returned in the search
* results.
*/
public void setReturnEnabled(Boolean returnEnabled) {
this.returnEnabled = returnEnabled;
}
/**
* Whether the contents of the field can be returned in the search
* results.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param returnEnabled Whether the contents of the field can be returned in the search
* results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TextOptions withReturnEnabled(Boolean returnEnabled) {
this.returnEnabled = returnEnabled;
return this;
}
/**
* Whether the contents of the field can be returned in the search
* results.
*
* @return Whether the contents of the field can be returned in the search
* results.
*/
public Boolean getReturnEnabled() {
return returnEnabled;
}
/**
* Whether the field can be used to sort the search results.
*
* @return Whether the field can be used to sort the search results.
*/
public Boolean isSortEnabled() {
return sortEnabled;
}
/**
* Whether the field can be used to sort the search results.
*
* @param sortEnabled Whether the field can be used to sort the search results.
*/
public void setSortEnabled(Boolean sortEnabled) {
this.sortEnabled = sortEnabled;
}
/**
* Whether the field can be used to sort the search results.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param sortEnabled Whether the field can be used to sort the search results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TextOptions withSortEnabled(Boolean sortEnabled) {
this.sortEnabled = sortEnabled;
return this;
}
/**
* Whether the field can be used to sort the search results.
*
* @return Whether the field can be used to sort the search results.
*/
public Boolean getSortEnabled() {
return sortEnabled;
}
/**
* Whether highlights can be returned for the field.
*
* @return Whether highlights can be returned for the field.
*/
public Boolean isHighlightEnabled() {
return highlightEnabled;
}
/**
* Whether highlights can be returned for the field.
*
* @param highlightEnabled Whether highlights can be returned for the field.
*/
public void setHighlightEnabled(Boolean highlightEnabled) {
this.highlightEnabled = highlightEnabled;
}
/**
* Whether highlights can be returned for the field.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param highlightEnabled Whether highlights can be returned for the field.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TextOptions withHighlightEnabled(Boolean highlightEnabled) {
this.highlightEnabled = highlightEnabled;
return this;
}
/**
* Whether highlights can be returned for the field.
*
* @return Whether highlights can be returned for the field.
*/
public Boolean getHighlightEnabled() {
return highlightEnabled;
}
/**
* The name of an analysis scheme for a text field.
*
* Constraints:
* Pattern: [\S]+
*
* @return The name of an analysis scheme for a text field.
*/
public String getAnalysisScheme() {
return analysisScheme;
}
/**
* The name of an analysis scheme for a text field.
*
* Constraints:
* Pattern: [\S]+
*
* @param analysisScheme The name of an analysis scheme for a text field.
*/
public void setAnalysisScheme(String analysisScheme) {
this.analysisScheme = analysisScheme;
}
/**
* The name of an analysis scheme for a text field.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Pattern: [\S]+
*
* @param analysisScheme The name of an analysis scheme for a text field.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TextOptions withAnalysisScheme(String analysisScheme) {
this.analysisScheme = analysisScheme;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDefaultValue() != null) sb.append("DefaultValue: " + getDefaultValue() + ",");
if (getSourceField() != null) sb.append("SourceField: " + getSourceField() + ",");
if (isReturnEnabled() != null) sb.append("ReturnEnabled: " + isReturnEnabled() + ",");
if (isSortEnabled() != null) sb.append("SortEnabled: " + isSortEnabled() + ",");
if (isHighlightEnabled() != null) sb.append("HighlightEnabled: " + isHighlightEnabled() + ",");
if (getAnalysisScheme() != null) sb.append("AnalysisScheme: " + getAnalysisScheme() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDefaultValue() == null) ? 0 : getDefaultValue().hashCode());
hashCode = prime * hashCode + ((getSourceField() == null) ? 0 : getSourceField().hashCode());
hashCode = prime * hashCode + ((isReturnEnabled() == null) ? 0 : isReturnEnabled().hashCode());
hashCode = prime * hashCode + ((isSortEnabled() == null) ? 0 : isSortEnabled().hashCode());
hashCode = prime * hashCode + ((isHighlightEnabled() == null) ? 0 : isHighlightEnabled().hashCode());
hashCode = prime * hashCode + ((getAnalysisScheme() == null) ? 0 : getAnalysisScheme().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof TextOptions == false) return false;
TextOptions other = (TextOptions)obj;
if (other.getDefaultValue() == null ^ this.getDefaultValue() == null) return false;
if (other.getDefaultValue() != null && other.getDefaultValue().equals(this.getDefaultValue()) == false) return false;
if (other.getSourceField() == null ^ this.getSourceField() == null) return false;
if (other.getSourceField() != null && other.getSourceField().equals(this.getSourceField()) == false) return false;
if (other.isReturnEnabled() == null ^ this.isReturnEnabled() == null) return false;
if (other.isReturnEnabled() != null && other.isReturnEnabled().equals(this.isReturnEnabled()) == false) return false;
if (other.isSortEnabled() == null ^ this.isSortEnabled() == null) return false;
if (other.isSortEnabled() != null && other.isSortEnabled().equals(this.isSortEnabled()) == false) return false;
if (other.isHighlightEnabled() == null ^ this.isHighlightEnabled() == null) return false;
if (other.isHighlightEnabled() != null && other.isHighlightEnabled().equals(this.isHighlightEnabled()) == false) return false;
if (other.getAnalysisScheme() == null ^ this.getAnalysisScheme() == null) return false;
if (other.getAnalysisScheme() != null && other.getAnalysisScheme().equals(this.getAnalysisScheme()) == false) return false;
return true;
}
}