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

Class DocumentAttributeValueCountPair

java.lang.Object

software.amazon.awssdk.services.kendra.model.DocumentAttributeValueCountPair

All Implemented Interfaces:

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

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

Provides the count of documents that match a particular document attribute or field when doing a faceted search.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentAttributeValueCountPair.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentAttributeValueCountPair.Builder	builder()
Integer	count()	The number of documents in the response that have the attribute/field value for the key.
DocumentAttributeValue	documentAttributeValue()	The value of the attribute/field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FacetResult>	facetResults()	Contains the results of a document attribute/field that is a nested facet.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFacetResults()	For responses, this returns true if the service returned a value for the FacetResults property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentAttributeValueCountPair.Builder>	serializableBuilderClass()
DocumentAttributeValueCountPair.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

documentAttributeValue

public final DocumentAttributeValue documentAttributeValue()

The value of the attribute/field. For example, "HR".

Returns:

The value of the attribute/field. For example, "HR".

count

public final Integer count()

The number of documents in the response that have the attribute/field value for the key.

Returns:

The number of documents in the response that have the attribute/field value for the key.

hasFacetResults

public final boolean hasFacetResults()

For responses, this returns true if the service returned a value for the FacetResults 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.

facetResults

public final List<FacetResult> facetResults()

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested 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. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

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 hasFacetResults() method.

Returns:

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested 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. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

toBuilder

public DocumentAttributeValueCountPair.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentAttributeValueCountPair.Builder,DocumentAttributeValueCountPair>

builder

public static DocumentAttributeValueCountPair.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentAttributeValueCountPair.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