Facet (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Facet
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about a document attribute or field. You can use document attributes as facets.

For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.

You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Facet()

Constructors
Constructor and Description
`Facet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Facet`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDocumentAttributeKey()` The unique key for the document attribute.
`List<Facet>`	`getFacets()` An array of document attributes that are nested facets within a facet.
`Integer`	`getMaxResults()` Maximum number of facet values per facet.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDocumentAttributeKey(String documentAttributeKey)` The unique key for the document attribute.
`void`	`setFacets(Collection<Facet> facets)` An array of document attributes that are nested facets within a facet.
`void`	`setMaxResults(Integer maxResults)` Maximum number of facet values per facet.
`String`	`toString()` Returns a string representation of this object.
`Facet`	`withDocumentAttributeKey(String documentAttributeKey)` The unique key for the document attribute.
`Facet`	`withFacets(Collection<Facet> facets)` An array of document attributes that are nested facets within a facet.
`Facet`	`withFacets(Facet... facets)` An array of document attributes that are nested facets within a facet.
`Facet`	`withMaxResults(Integer maxResults)` Maximum number of facet values per facet.

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

- Constructor Detail
  - Facet
```
public Facet()
```
- Method Detail
  - setDocumentAttributeKey
```
public void setDocumentAttributeKey(String documentAttributeKey)
```
    The unique key for the document attribute.
    
    Parameters:
    
    documentAttributeKey - The unique key for the document attribute.
  - getDocumentAttributeKey
```
public String getDocumentAttributeKey()
```
    The unique key for the document attribute.
    
    Returns:
    
    The unique key for the document attribute.
  - withDocumentAttributeKey
```
public Facet withDocumentAttributeKey(String documentAttributeKey)
```
    The unique key for the document attribute.
    
    Parameters:
    
    documentAttributeKey - The unique key for the document attribute.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFacets
```
public List<Facet> getFacets()
```
    An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
    
    Returns:
    
    An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
  - setFacets
```
public void setFacets(Collection<Facet> facets)
```
    An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
    
    Parameters:
    
    facets - An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
  - withFacets
```
public Facet withFacets(Facet... facets)
```
    An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
    
    NOTE: This method appends the values to the existing list (if any). Use setFacets(java.util.Collection) or withFacets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    facets - An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFacets
```
public Facet withFacets(Collection<Facet> facets)
```
    An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
    
    Parameters:
    
    facets - An array of document attributes that are nested facets within a facet.
    
    For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
    
    You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
    
    Parameters:
    
    maxResults - Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
    
    Returns:
    
    Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
  - withMaxResults
```
public Facet withMaxResults(Integer maxResults)
```
    Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
    
    Parameters:
    
    maxResults - Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Facet 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.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Facet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Facet

Method Detail

setDocumentAttributeKey

getDocumentAttributeKey

withDocumentAttributeKey

getFacets

setFacets

withFacets

withFacets

setMaxResults

getMaxResults

withMaxResults

toString

equals

hashCode

clone

marshall