public class IntOptions extends Object implements Serializable
Options for a 64-bit signed integer field. Present if
IndexFieldType
specifies the field is of type
int
. All options are enabled by default.
Constructor and Description |
---|
IntOptions() |
Modifier and Type | Method and Description |
---|---|
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.
|
public Long getDefaultValue()
public void setDefaultValue(Long 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.public IntOptions withDefaultValue(Long defaultValue)
Returns a reference to this object so that method calls can be chained together.
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 String getSourceField()
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
public void setSourceField(String sourceField)
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
sourceField
- The name of the source field to map to the field.public IntOptions withSourceField(String sourceField)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
sourceField
- The name of the source field to map to the field.public Boolean isFacetEnabled()
public void setFacetEnabled(Boolean facetEnabled)
facetEnabled
- Whether facet information can be returned for the field.public IntOptions withFacetEnabled(Boolean facetEnabled)
Returns a reference to this object so that method calls can be chained together.
facetEnabled
- Whether facet information can be returned for the field.public Boolean getFacetEnabled()
public Boolean isSearchEnabled()
public void setSearchEnabled(Boolean searchEnabled)
searchEnabled
- Whether the contents of the field are searchable.public IntOptions withSearchEnabled(Boolean searchEnabled)
Returns a reference to this object so that method calls can be chained together.
searchEnabled
- Whether the contents of the field are searchable.public Boolean getSearchEnabled()
public Boolean isReturnEnabled()
public void setReturnEnabled(Boolean returnEnabled)
returnEnabled
- Whether the contents of the field can be returned in the search
results.public IntOptions withReturnEnabled(Boolean returnEnabled)
Returns a reference to this object so that method calls can be chained together.
returnEnabled
- Whether the contents of the field can be returned in the search
results.public Boolean getReturnEnabled()
public Boolean isSortEnabled()
public void setSortEnabled(Boolean sortEnabled)
sortEnabled
- Whether the field can be used to sort the search results.public IntOptions withSortEnabled(Boolean sortEnabled)
Returns a reference to this object so that method calls can be chained together.
sortEnabled
- Whether the field can be used to sort the search results.public Boolean getSortEnabled()
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.