com.amazonaws.services.cloudsearchv2.model.DoubleOptions Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudsearch 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.cloudsearchv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the
* field is of type double. All options are enabled by default.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DoubleOptions implements Serializable, Cloneable {
/**
*
* A value to use for the field if the field isn't specified for a document. This can be important if you are using
* the field in an expression and that field is not present in every document.
*
*/
private Double defaultValue;
/**
*
* The name of the source field to map to the field.
*
*/
private String sourceField;
/**
*
* Whether facet information can be returned for the field.
*
*/
private Boolean facetEnabled;
/**
*
* Whether the contents of the field are searchable.
*
*/
private Boolean searchEnabled;
/**
*
* 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;
/**
*
* A value to use for the field if the field isn't specified for a document. This can be important if you are using
* the field in an expression and that field is not present in every document.
*
*
* @param defaultValue
* A value to use for the field if the field isn't specified for a document. This can be important if you are
* using the field in an expression and that field is not present in every document.
*/
public void setDefaultValue(Double defaultValue) {
this.defaultValue = defaultValue;
}
/**
*
* A value to use for the field if the field isn't specified for a document. This can be important if you are using
* the field in an expression and that field is not present in every document.
*
*
* @return A value to use for the field if the field isn't specified for a document. This can be important if you
* are using the field in an expression and that field is not present in every document.
*/
public Double getDefaultValue() {
return this.defaultValue;
}
/**
*
* A value to use for the field if the field isn't specified for a document. This can be important if you are using
* the field in an expression and that field is not present in every document.
*
*
* @param defaultValue
* A value to use for the field if the field isn't specified for a document. This can be important if you are
* using the field in an expression and that field is not present in every document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DoubleOptions withDefaultValue(Double defaultValue) {
setDefaultValue(defaultValue);
return this;
}
/**
*
* The name of the source field to map to the field.
*
*
* @param sourceField
* The name of the source field to map to the field.
*/
public void setSourceField(String sourceField) {
this.sourceField = sourceField;
}
/**
*
* The name of the source field to map to the field.
*
*
* @return The name of the source field to map to the field.
*/
public String getSourceField() {
return this.sourceField;
}
/**
*
* The name of the source field to map to the field.
*
*
* @param sourceField
* The name of the source field to map to the field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DoubleOptions withSourceField(String sourceField) {
setSourceField(sourceField);
return this;
}
/**
*
* Whether facet information can be returned for the field.
*
*
* @param facetEnabled
* Whether facet information can be returned for the field.
*/
public void setFacetEnabled(Boolean facetEnabled) {
this.facetEnabled = facetEnabled;
}
/**
*
* Whether facet information can be returned for the field.
*
*
* @return Whether facet information can be returned for the field.
*/
public Boolean getFacetEnabled() {
return this.facetEnabled;
}
/**
*
* Whether facet information can be returned for the field.
*
*
* @param facetEnabled
* Whether facet information can be returned for the field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DoubleOptions withFacetEnabled(Boolean facetEnabled) {
setFacetEnabled(facetEnabled);
return this;
}
/**
*
* Whether facet information can be returned for the field.
*
*
* @return Whether facet information can be returned for the field.
*/
public Boolean isFacetEnabled() {
return this.facetEnabled;
}
/**
*
* Whether the contents of the field are searchable.
*
*
* @param searchEnabled
* Whether the contents of the field are searchable.
*/
public void setSearchEnabled(Boolean searchEnabled) {
this.searchEnabled = searchEnabled;
}
/**
*
* Whether the contents of the field are searchable.
*
*
* @return Whether the contents of the field are searchable.
*/
public Boolean getSearchEnabled() {
return this.searchEnabled;
}
/**
*
* Whether the contents of the field are searchable.
*
*
* @param searchEnabled
* Whether the contents of the field are searchable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DoubleOptions withSearchEnabled(Boolean searchEnabled) {
setSearchEnabled(searchEnabled);
return this;
}
/**
*
* Whether the contents of the field are searchable.
*
*
* @return Whether the contents of the field are searchable.
*/
public Boolean isSearchEnabled() {
return this.searchEnabled;
}
/**
*
* 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.
*
*
* @return Whether the contents of the field can be returned in the search results.
*/
public Boolean getReturnEnabled() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DoubleOptions withReturnEnabled(Boolean returnEnabled) {
setReturnEnabled(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 isReturnEnabled() {
return this.returnEnabled;
}
/**
*
* 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.
*
*
* @return Whether the field can be used to sort the search results.
*/
public Boolean getSortEnabled() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DoubleOptions withSortEnabled(Boolean sortEnabled) {
setSortEnabled(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 isSortEnabled() {
return this.sortEnabled;
}
/**
* 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 (getDefaultValue() != null)
sb.append("DefaultValue: ").append(getDefaultValue()).append(",");
if (getSourceField() != null)
sb.append("SourceField: ").append(getSourceField()).append(",");
if (getFacetEnabled() != null)
sb.append("FacetEnabled: ").append(getFacetEnabled()).append(",");
if (getSearchEnabled() != null)
sb.append("SearchEnabled: ").append(getSearchEnabled()).append(",");
if (getReturnEnabled() != null)
sb.append("ReturnEnabled: ").append(getReturnEnabled()).append(",");
if (getSortEnabled() != null)
sb.append("SortEnabled: ").append(getSortEnabled());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DoubleOptions == false)
return false;
DoubleOptions other = (DoubleOptions) 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.getFacetEnabled() == null ^ this.getFacetEnabled() == null)
return false;
if (other.getFacetEnabled() != null && other.getFacetEnabled().equals(this.getFacetEnabled()) == false)
return false;
if (other.getSearchEnabled() == null ^ this.getSearchEnabled() == null)
return false;
if (other.getSearchEnabled() != null && other.getSearchEnabled().equals(this.getSearchEnabled()) == false)
return false;
if (other.getReturnEnabled() == null ^ this.getReturnEnabled() == null)
return false;
if (other.getReturnEnabled() != null && other.getReturnEnabled().equals(this.getReturnEnabled()) == false)
return false;
if (other.getSortEnabled() == null ^ this.getSortEnabled() == null)
return false;
if (other.getSortEnabled() != null && other.getSortEnabled().equals(this.getSortEnabled()) == false)
return false;
return true;
}
@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 + ((getFacetEnabled() == null) ? 0 : getFacetEnabled().hashCode());
hashCode = prime * hashCode + ((getSearchEnabled() == null) ? 0 : getSearchEnabled().hashCode());
hashCode = prime * hashCode + ((getReturnEnabled() == null) ? 0 : getReturnEnabled().hashCode());
hashCode = prime * hashCode + ((getSortEnabled() == null) ? 0 : getSortEnabled().hashCode());
return hashCode;
}
@Override
public DoubleOptions clone() {
try {
return (DoubleOptions) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}