Package software.amazon.awssdk.services.kendra.model

Class Facet

java.lang.Object

software.amazon.awssdk.services.kendra.model.Facet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Facet.Builder,Facet>

@Generated("software.amazon.awssdk:codegen")
public final class Facet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Facet.Builder,Facet>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Facet.Builder

Method Summary

Modifier and Type	Method	Description
static Facet.Builder	builder()
String	documentAttributeKey()	The unique key for the document attribute.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Facet>	facets()	An array of document attributes that are nested facets within a facet.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFacets()	For responses, this returns true if the service returned a value for the Facets property.
int	hashCode()
Integer	maxResults()	Maximum number of facet values per facet.
List<SdkField<?>>	sdkFields()
static Class<? extends Facet.Builder>	serializableBuilderClass()
Facet.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

documentAttributeKey

public final String documentAttributeKey()

The unique key for the document attribute.

Returns:

The unique key for the document attribute.

hasFacets

public final boolean hasFacets()

For responses, this returns true if the service returned a value for the Facets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

facets

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFacets() method.

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.

maxResults

public final 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.

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.

toBuilder

public Facet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Facet.Builder,Facet>

builder

public static Facet.Builder builder()

serializableBuilderClass

public static Class<? extends Facet.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo