Class DoubleOptions

java.lang.Object
com.amazonaws.services.cloudsearchv2.model.DoubleOptions
All Implemented Interfaces:
Serializable, Cloneable

public class DoubleOptions extends Object implements Serializable, Cloneable

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.

See Also:
  • Constructor Details

    • DoubleOptions

      public DoubleOptions()
  • Method Details

    • setDefaultValue

      public void setDefaultValue(Double 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.

      Parameters:
      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.
    • getDefaultValue

      public Double getDefaultValue()

      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.

      Returns:
      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.
    • withDefaultValue

      public DoubleOptions withDefaultValue(Double 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSourceField

      public void setSourceField(String sourceField)

      The name of the source field to map to the field.

      Parameters:
      sourceField - The name of the source field to map to the field.
    • getSourceField

      public String getSourceField()

      The name of the source field to map to the field.

      Returns:
      The name of the source field to map to the field.
    • withSourceField

      public DoubleOptions withSourceField(String sourceField)

      The name of the source field to map to the field.

      Parameters:
      sourceField - The name of the source field to map to the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setFacetEnabled

      public void setFacetEnabled(Boolean facetEnabled)

      Whether facet information can be returned for the field.

      Parameters:
      facetEnabled - Whether facet information can be returned for the field.
    • getFacetEnabled

      public Boolean getFacetEnabled()

      Whether facet information can be returned for the field.

      Returns:
      Whether facet information can be returned for the field.
    • withFacetEnabled

      public DoubleOptions withFacetEnabled(Boolean facetEnabled)

      Whether facet information can be returned for the field.

      Parameters:
      facetEnabled - Whether facet information can be returned for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isFacetEnabled

      public Boolean isFacetEnabled()

      Whether facet information can be returned for the field.

      Returns:
      Whether facet information can be returned for the field.
    • setSearchEnabled

      public void setSearchEnabled(Boolean searchEnabled)

      Whether the contents of the field are searchable.

      Parameters:
      searchEnabled - Whether the contents of the field are searchable.
    • getSearchEnabled

      public Boolean getSearchEnabled()

      Whether the contents of the field are searchable.

      Returns:
      Whether the contents of the field are searchable.
    • withSearchEnabled

      public DoubleOptions withSearchEnabled(Boolean searchEnabled)

      Whether the contents of the field are searchable.

      Parameters:
      searchEnabled - Whether the contents of the field are searchable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isSearchEnabled

      public Boolean isSearchEnabled()

      Whether the contents of the field are searchable.

      Returns:
      Whether the contents of the field are searchable.
    • setReturnEnabled

      public void setReturnEnabled(Boolean returnEnabled)

      Whether the contents of the field can be returned in the search results.

      Parameters:
      returnEnabled - Whether the contents of the field can be returned in the search results.
    • getReturnEnabled

      public Boolean getReturnEnabled()

      Whether the contents of the field can be returned in the search results.

      Returns:
      Whether the contents of the field can be returned in the search results.
    • withReturnEnabled

      public DoubleOptions withReturnEnabled(Boolean returnEnabled)

      Whether the contents of the field can be returned in the search results.

      Parameters:
      returnEnabled - Whether the contents of the field can be returned in the search results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isReturnEnabled

      public Boolean isReturnEnabled()

      Whether the contents of the field can be returned in the search results.

      Returns:
      Whether the contents of the field can be returned in the search results.
    • setSortEnabled

      public void setSortEnabled(Boolean sortEnabled)

      Whether the field can be used to sort the search results.

      Parameters:
      sortEnabled - Whether the field can be used to sort the search results.
    • getSortEnabled

      public Boolean getSortEnabled()

      Whether the field can be used to sort the search results.

      Returns:
      Whether the field can be used to sort the search results.
    • withSortEnabled

      public DoubleOptions withSortEnabled(Boolean sortEnabled)

      Whether the field can be used to sort the search results.

      Parameters:
      sortEnabled - Whether the field can be used to sort the search results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isSortEnabled

      public Boolean isSortEnabled()

      Whether the field can be used to sort the search results.

      Returns:
      Whether the field can be used to sort the search results.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DoubleOptions clone()
      Overrides:
      clone in class Object