Class IntOptions
- java.lang.Object
-
- com.amazonaws.services.cloudsearchv2.model.IntOptions
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class IntOptions extends Object implements Serializable, Cloneable
Options for a 64-bit signed integer field. Present if
IndexFieldType
specifies the field is of typeint
. All options are enabled by default.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IntOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IntOptions
clone()
boolean
equals(Object obj)
Long
getDefaultValue()
A value to use for the field if the field isn't specified for a document.Boolean
getFacetEnabled()
Whether facet information can be returned for the field.Boolean
getReturnEnabled()
Whether the contents of the field can be returned in the search results.Boolean
getSearchEnabled()
Whether the contents of the field are searchable.Boolean
getSortEnabled()
Whether the field can be used to sort the search results.String
getSourceField()
The name of the source field to map to the field.int
hashCode()
Boolean
isFacetEnabled()
Whether facet information can be returned for the field.Boolean
isReturnEnabled()
Whether the contents of the field can be returned in the search results.Boolean
isSearchEnabled()
Whether the contents of the field are searchable.Boolean
isSortEnabled()
Whether the field can be used to sort the search results.void
setDefaultValue(Long defaultValue)
A value to use for the field if the field isn't specified for a document.void
setFacetEnabled(Boolean facetEnabled)
Whether facet information can be returned for the field.void
setReturnEnabled(Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.void
setSearchEnabled(Boolean searchEnabled)
Whether the contents of the field are searchable.void
setSortEnabled(Boolean sortEnabled)
Whether the field can be used to sort the search results.void
setSourceField(String sourceField)
The name of the source field to map to the field.String
toString()
Returns a string representation of this object; useful for testing and debugging.IntOptions
withDefaultValue(Long defaultValue)
A value to use for the field if the field isn't specified for a document.IntOptions
withFacetEnabled(Boolean facetEnabled)
Whether facet information can be returned for the field.IntOptions
withReturnEnabled(Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.IntOptions
withSearchEnabled(Boolean searchEnabled)
Whether the contents of the field are searchable.IntOptions
withSortEnabled(Boolean sortEnabled)
Whether the field can be used to sort the search results.IntOptions
withSourceField(String sourceField)
The name of the source field to map to the field.
-
-
-
Method Detail
-
setDefaultValue
public void setDefaultValue(Long 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 Long 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 IntOptions withDefaultValue(Long 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 IntOptions 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 IntOptions 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 IntOptions 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 IntOptions 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 IntOptions 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public IntOptions clone()
-
-