Class LiteralOptions
- java.lang.Object
-
- com.amazonaws.services.cloudsearchv2.model.LiteralOptions
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class LiteralOptions extends Object implements Serializable, Cloneable
Options for literal field. Present if
IndexFieldType
specifies the field is of typeliteral
. All options are enabled by default.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LiteralOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LiteralOptions
clone()
boolean
equals(Object obj)
String
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()
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(String 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)
String
toString()
Returns a string representation of this object; useful for testing and debugging.LiteralOptions
withDefaultValue(String defaultValue)
A value to use for the field if the field isn't specified for a document.LiteralOptions
withFacetEnabled(Boolean facetEnabled)
Whether facet information can be returned for the field.LiteralOptions
withReturnEnabled(Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.LiteralOptions
withSearchEnabled(Boolean searchEnabled)
Whether the contents of the field are searchable.LiteralOptions
withSortEnabled(Boolean sortEnabled)
Whether the field can be used to sort the search results.LiteralOptions
withSourceField(String sourceField)
-
-
-
Method Detail
-
setDefaultValue
public void setDefaultValue(String defaultValue)
A value to use for the field if the field isn't specified for a document.- Parameters:
defaultValue
- A value to use for the field if the field isn't specified for a document.
-
getDefaultValue
public String getDefaultValue()
A value to use for the field if the field isn't specified for a document.- Returns:
- A value to use for the field if the field isn't specified for a document.
-
withDefaultValue
public LiteralOptions withDefaultValue(String defaultValue)
A value to use for the field if the field isn't specified for a document.- Parameters:
defaultValue
- A value to use for the field if the field isn't specified for a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceField
public void setSourceField(String sourceField)
- Parameters:
sourceField
-
-
getSourceField
public String getSourceField()
- Returns:
-
withSourceField
public LiteralOptions withSourceField(String sourceField)
- Parameters:
sourceField
-- 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 LiteralOptions 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 LiteralOptions 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 LiteralOptions 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 LiteralOptions 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 LiteralOptions clone()
-
-