com.amazonaws.services.kendraranking.model

Class RescoreRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendraranking.model.RescoreRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RescoreRequest()

Method Summary

Modifier and Type	Method and Description
RescoreRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Document>	getDocuments() The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
String	getRescoreExecutionPlanId() The identifier of the rescore execution plan.
String	getSearchQuery() The input query from the search service.
int	hashCode()
void	setDocuments(Collection<Document> documents) The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
void	setRescoreExecutionPlanId(String rescoreExecutionPlanId) The identifier of the rescore execution plan.
void	setSearchQuery(String searchQuery) The input query from the search service.
String	toString() Returns a string representation of this object.
RescoreRequest	withDocuments(Collection<Document> documents) The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
RescoreRequest	withDocuments(Document... documents) The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
RescoreRequest	withRescoreExecutionPlanId(String rescoreExecutionPlanId) The identifier of the rescore execution plan.
RescoreRequest	withSearchQuery(String searchQuery) The input query from the search service.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RescoreRequest

public RescoreRequest()

Method Detail

setRescoreExecutionPlanId

public void setRescoreExecutionPlanId(String rescoreExecutionPlanId)

The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Parameters:

rescoreExecutionPlanId - The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

getRescoreExecutionPlanId

public String getRescoreExecutionPlanId()

The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Returns:

The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

withRescoreExecutionPlanId

public RescoreRequest withRescoreExecutionPlanId(String rescoreExecutionPlanId)

The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Parameters:

rescoreExecutionPlanId - The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Returns:

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

setSearchQuery

public void setSearchQuery(String searchQuery)

The input query from the search service.

Parameters:

searchQuery - The input query from the search service.

getSearchQuery

public String getSearchQuery()

The input query from the search service.

Returns:

The input query from the search service.

withSearchQuery

public RescoreRequest withSearchQuery(String searchQuery)

The input query from the search service.

Parameters:

searchQuery - The input query from the search service.

Returns:

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

getDocuments

public List<Document> getDocuments()

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Returns:

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

setDocuments

public void setDocuments(Collection<Document> documents)

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Parameters:

documents - The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

withDocuments

public RescoreRequest withDocuments(Document... documents)

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

NOTE: This method appends the values to the existing list (if any). Use setDocuments(java.util.Collection) or withDocuments(java.util.Collection) if you want to override the existing values.

Parameters:

documents - The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Returns:

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

withDocuments

public RescoreRequest withDocuments(Collection<Document> documents)

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Parameters:

documents - The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

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 RescoreRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()