software.amazon.awssdk.services.kendra.model

Class ExpandConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ExpandConfiguration

All Implemented Interfaces:

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

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

Specifies the configuration information needed to customize how collapsed search result groups expand.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExpandConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ExpandConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxExpandedResultsPerItem() The number of expanded results to show per collapsed primary document.
Integer	maxResultItemsToExpand() The number of collapsed search result groups to expand.
List<SdkField<?>>	sdkFields()
static Class<? extends ExpandConfiguration.Builder>	serializableBuilderClass()
ExpandConfiguration.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

maxResultItemsToExpand

public final Integer maxResultItemsToExpand()

The number of collapsed search result groups to expand. If you set this value to 10, for example, only the first 10 out of 100 result groups will have expand functionality.

Returns:

The number of collapsed search result groups to expand. If you set this value to 10, for example, only the first 10 out of 100 result groups will have expand functionality.

maxExpandedResultsPerItem

public final Integer maxExpandedResultsPerItem()

The number of expanded results to show per collapsed primary document. For instance, if you set this value to 3, then at most 3 results per collapsed group will be displayed.

Returns:

The number of expanded results to show per collapsed primary document. For instance, if you set this value to 3, then at most 3 results per collapsed group will be displayed.

toBuilder

public ExpandConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExpandConfiguration.Builder,ExpandConfiguration>

builder

public static ExpandConfiguration.Builder builder()

serializableBuilderClass

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