com.amazonaws.services.kendra.model

Class DocumentRelevanceConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.DocumentRelevanceConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentRelevanceConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Overrides the document relevance properties of a custom index field.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentRelevanceConfiguration()

Method Summary

Modifier and Type	Method and Description
DocumentRelevanceConfiguration	clone()
boolean	equals(Object obj)
String	getName() The name of the index field.
Relevance	getRelevance() Provides information for tuning the relevance of a field in a search.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setName(String name) The name of the index field.
void	setRelevance(Relevance relevance) Provides information for tuning the relevance of a field in a search.
String	toString() Returns a string representation of this object.
DocumentRelevanceConfiguration	withName(String name) The name of the index field.
DocumentRelevanceConfiguration	withRelevance(Relevance relevance) Provides information for tuning the relevance of a field in a search.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentRelevanceConfiguration

public DocumentRelevanceConfiguration()

Method Detail

setName

public void setName(String name)

The name of the index field.

Parameters:

name - The name of the index field.

getName

public String getName()

The name of the index field.

Returns:

The name of the index field.

withName

public DocumentRelevanceConfiguration withName(String name)

The name of the index field.

Parameters:

name - The name of the index field.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRelevance

public void setRelevance(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.

Parameters:

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.

getRelevance

public Relevance getRelevance()

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.

withRelevance

public DocumentRelevanceConfiguration withRelevance(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DocumentRelevanceConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.