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

Class FacetResult

java.lang.Object

software.amazon.awssdk.services.kendra.model.FacetResult

All Implemented Interfaces:

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

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

The facet values for the documents in the response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FacetResult.Builder

Method Summary

Modifier and Type	Method	Description
static FacetResult.Builder	builder()
String	documentAttributeKey()	The key for the facet values.
List<DocumentAttributeValueCountPair>	documentAttributeValueCountPairs()	An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
DocumentAttributeValueType	documentAttributeValueType()	The data type of the facet value.
String	documentAttributeValueTypeAsString()	The data type of the facet value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentAttributeValueCountPairs()	For responses, this returns true if the service returned a value for the DocumentAttributeValueCountPairs property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FacetResult.Builder>	serializableBuilderClass()
FacetResult.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 key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Returns:

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

documentAttributeValueType

public final DocumentAttributeValueType documentAttributeValueType()

The data type of the facet value. This is the same as the type defined for the index field when it was created.

If the service returns an enum value that is not available in the current SDK version, documentAttributeValueType will return DocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentAttributeValueTypeAsString().

Returns:

The data type of the facet value. This is the same as the type defined for the index field when it was created.

See Also:

DocumentAttributeValueType

documentAttributeValueTypeAsString

public final String documentAttributeValueTypeAsString()

The data type of the facet value. This is the same as the type defined for the index field when it was created.

If the service returns an enum value that is not available in the current SDK version, documentAttributeValueType will return DocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentAttributeValueTypeAsString().

Returns:

The data type of the facet value. This is the same as the type defined for the index field when it was created.

See Also:

DocumentAttributeValueType

hasDocumentAttributeValueCountPairs

public final boolean hasDocumentAttributeValueCountPairs()

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

documentAttributeValueCountPairs

public final List<DocumentAttributeValueCountPair> documentAttributeValueCountPairs()

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

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

Returns:

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

toBuilder

public FacetResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FacetResult.Builder,FacetResult>

builder

public static FacetResult.Builder builder()

serializableBuilderClass

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