@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Search extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about how a custom index field is used during a search.
Constructor and Description |
---|
Search() |
Modifier and Type | Method and Description |
---|---|
Search |
clone() |
boolean |
equals(Object obj) |
Boolean |
getDisplayable()
Determines whether the field is returned in the query response.
|
Boolean |
getFacetable()
Indicates that the field can be used to create search facets, a count of results for each value in the field.
|
Boolean |
getSearchable()
Determines whether the field is used in the search.
|
Boolean |
getSortable()
Determines whether the field can be used to sort the results of a query.
|
int |
hashCode() |
Boolean |
isDisplayable()
Determines whether the field is returned in the query response.
|
Boolean |
isFacetable()
Indicates that the field can be used to create search facets, a count of results for each value in the field.
|
Boolean |
isSearchable()
Determines whether the field is used in the search.
|
Boolean |
isSortable()
Determines whether the field can be used to sort the results of a query.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDisplayable(Boolean displayable)
Determines whether the field is returned in the query response.
|
void |
setFacetable(Boolean facetable)
Indicates that the field can be used to create search facets, a count of results for each value in the field.
|
void |
setSearchable(Boolean searchable)
Determines whether the field is used in the search.
|
void |
setSortable(Boolean sortable)
Determines whether the field can be used to sort the results of a query.
|
String |
toString()
Returns a string representation of this object.
|
Search |
withDisplayable(Boolean displayable)
Determines whether the field is returned in the query response.
|
Search |
withFacetable(Boolean facetable)
Indicates that the field can be used to create search facets, a count of results for each value in the field.
|
Search |
withSearchable(Boolean searchable)
Determines whether the field is used in the search.
|
Search |
withSortable(Boolean sortable)
Determines whether the field can be used to sort the results of a query.
|
public void setFacetable(Boolean facetable)
Indicates that the field can be used to create search facets, a count of results for each value in the field. The
default is false
.
facetable
- Indicates that the field can be used to create search facets, a count of results for each value in the
field. The default is false
.public Boolean getFacetable()
Indicates that the field can be used to create search facets, a count of results for each value in the field. The
default is false
.
false
.public Search withFacetable(Boolean facetable)
Indicates that the field can be used to create search facets, a count of results for each value in the field. The
default is false
.
facetable
- Indicates that the field can be used to create search facets, a count of results for each value in the
field. The default is false
.public Boolean isFacetable()
Indicates that the field can be used to create search facets, a count of results for each value in the field. The
default is false
.
false
.public void setSearchable(Boolean searchable)
Determines whether the field is used in the search. If the Searchable
field is true
,
you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
true
for string fields and false
for number and date fields.
searchable
- Determines whether the field is used in the search. If the Searchable
field is
true
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
the search. The default is true
for string fields and false
for number and date
fields.public Boolean getSearchable()
Determines whether the field is used in the search. If the Searchable
field is true
,
you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
true
for string fields and false
for number and date fields.
Searchable
field is
true
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
the search. The default is true
for string fields and false
for number and date
fields.public Search withSearchable(Boolean searchable)
Determines whether the field is used in the search. If the Searchable
field is true
,
you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
true
for string fields and false
for number and date fields.
searchable
- Determines whether the field is used in the search. If the Searchable
field is
true
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
the search. The default is true
for string fields and false
for number and date
fields.public Boolean isSearchable()
Determines whether the field is used in the search. If the Searchable
field is true
,
you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
true
for string fields and false
for number and date fields.
Searchable
field is
true
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in
the search. The default is true
for string fields and false
for number and date
fields.public void setDisplayable(Boolean displayable)
Determines whether the field is returned in the query response. The default is true
.
displayable
- Determines whether the field is returned in the query response. The default is true
.public Boolean getDisplayable()
Determines whether the field is returned in the query response. The default is true
.
true
.public Search withDisplayable(Boolean displayable)
Determines whether the field is returned in the query response. The default is true
.
displayable
- Determines whether the field is returned in the query response. The default is true
.public Boolean isDisplayable()
Determines whether the field is returned in the query response. The default is true
.
true
.public void setSortable(Boolean sortable)
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that
does not have Sortable
set to true
, Amazon Kendra returns an exception. The default is
false
.
sortable
- Determines whether the field can be used to sort the results of a query. If you specify sorting on a field
that does not have Sortable
set to true
, Amazon Kendra returns an exception. The
default is false
.public Boolean getSortable()
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that
does not have Sortable
set to true
, Amazon Kendra returns an exception. The default is
false
.
Sortable
set to true
, Amazon Kendra returns an
exception. The default is false
.public Search withSortable(Boolean sortable)
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that
does not have Sortable
set to true
, Amazon Kendra returns an exception. The default is
false
.
sortable
- Determines whether the field can be used to sort the results of a query. If you specify sorting on a field
that does not have Sortable
set to true
, Amazon Kendra returns an exception. The
default is false
.public Boolean isSortable()
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that
does not have Sortable
set to true
, Amazon Kendra returns an exception. The default is
false
.
Sortable
set to true
, Amazon Kendra returns an
exception. The default is false
.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.