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

Class DocumentRelevanceConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.DocumentRelevanceConfiguration

All Implemented Interfaces:

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

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

Overrides the document relevance properties of a custom index field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentRelevanceConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentRelevanceConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the index field.
Relevance	relevance()	Provides information for tuning the relevance of a field in a search.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentRelevanceConfiguration.Builder>	serializableBuilderClass()
DocumentRelevanceConfiguration.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

name

public final String name()

The name of the index field.

Returns:

The name of the index field.

relevance

public final Relevance relevance()

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Returns:

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

toBuilder

public DocumentRelevanceConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentRelevanceConfiguration.Builder,DocumentRelevanceConfiguration>

builder

public static DocumentRelevanceConfiguration.Builder builder()

serializableBuilderClass

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