Class LiteralArrayOptions
- java.lang.Object
-
- com.amazonaws.services.cloudsearchv2.model.LiteralArrayOptions
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class LiteralArrayOptions extends Object implements Serializable, Cloneable
Options for a field that contains an array of literal strings. Present if
IndexFieldType
specifies the field is of typeliteral-array
. All options are enabled by default.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LiteralArrayOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LiteralArrayOptions
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.String
getSourceFields()
A list of source fields 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.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
setSourceFields(String sourceFields)
A list of source fields to map to the field.String
toString()
Returns a string representation of this object; useful for testing and debugging.LiteralArrayOptions
withDefaultValue(String defaultValue)
A value to use for the field if the field isn't specified for a document.LiteralArrayOptions
withFacetEnabled(Boolean facetEnabled)
Whether facet information can be returned for the field.LiteralArrayOptions
withReturnEnabled(Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.LiteralArrayOptions
withSearchEnabled(Boolean searchEnabled)
Whether the contents of the field are searchable.LiteralArrayOptions
withSourceFields(String sourceFields)
A list of source fields to map to the field.
-
-
-
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 LiteralArrayOptions 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.
-
setSourceFields
public void setSourceFields(String sourceFields)
A list of source fields to map to the field.
- Parameters:
sourceFields
- A list of source fields to map to the field.
-
getSourceFields
public String getSourceFields()
A list of source fields to map to the field.
- Returns:
- A list of source fields to map to the field.
-
withSourceFields
public LiteralArrayOptions withSourceFields(String sourceFields)
A list of source fields to map to the field.
- Parameters:
sourceFields
- A list of source fields 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 LiteralArrayOptions 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 LiteralArrayOptions 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 LiteralArrayOptions 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.
-
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 LiteralArrayOptions clone()
-
-