Search (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.Search

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Search()

Constructors
Constructor and Description
`Search()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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.
`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.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Search
```
public Search()
```
- Method Detail
  - setFacetable
```
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 .
    
    Parameters:
    
    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 .
  - getFacetable
```
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 .
    
    Returns:
    
    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 .
  - withFacetable
```
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 .
    
    Parameters:
    
    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 .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFacetable
```
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 .
    
    Returns:
    
    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 .
  - setSearchable
```
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.
    
    Parameters:
    
    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.
  - getSearchable
```
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.
    
    Returns:
    
    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.
  - withSearchable
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSearchable
```
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.
    
    Returns:
    
    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.
  - setDisplayable
```
public void setDisplayable(Boolean displayable)
```
    Determines whether the field is returned in the query response. The default is true.
    
    Parameters:
    
    displayable - Determines whether the field is returned in the query response. The default is true.
  - getDisplayable
```
public Boolean getDisplayable()
```
    Determines whether the field is returned in the query response. The default is true.
    
    Returns:
    
    Determines whether the field is returned in the query response. The default is true.
  - withDisplayable
```
public Search withDisplayable(Boolean displayable)
```
    Determines whether the field is returned in the query response. The default is true.
    
    Parameters:
    
    displayable - Determines whether the field is returned in the query response. The default is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDisplayable
```
public Boolean isDisplayable()
```
    Determines whether the field is returned in the query response. The default is true.
    
    Returns:
    
    Determines whether the field is returned in the query response. The default is true.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Search clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Search

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Search

Method Detail

setFacetable

getFacetable

withFacetable

isFacetable

setSearchable

getSearchable

withSearchable

isSearchable

setDisplayable

getDisplayable

withDisplayable

isDisplayable

toString

equals

hashCode

clone

marshall