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

Class CollapsedResultDetail

java.lang.Object

software.amazon.awssdk.services.kendra.model.CollapsedResultDetail

All Implemented Interfaces:

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

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

Provides details about a collapsed group of search results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CollapsedResultDetail.Builder

Method Summary

Modifier and Type	Method	Description
static CollapsedResultDetail.Builder	builder()
DocumentAttribute	documentAttribute()	The value of the document attribute that results are collapsed on.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ExpandedResultItem>	expandedResults()	A list of results in the collapsed group.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExpandedResults()	For responses, this returns true if the service returned a value for the ExpandedResults property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CollapsedResultDetail.Builder>	serializableBuilderClass()
CollapsedResultDetail.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

documentAttribute

public final DocumentAttribute documentAttribute()

The value of the document attribute that results are collapsed on.

Returns:

The value of the document attribute that results are collapsed on.

hasExpandedResults

public final boolean hasExpandedResults()

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

expandedResults

public final List<ExpandedResultItem> expandedResults()

A list of results in the collapsed group.

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

Returns:

A list of results in the collapsed group.

toBuilder

public CollapsedResultDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CollapsedResultDetail.Builder,CollapsedResultDetail>

builder

public static CollapsedResultDetail.Builder builder()

serializableBuilderClass

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