software.amazon.awssdk.services.kendraranking.model

Class RescoreRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendraranking.model.KendraRankingRequest

software.amazon.awssdk.services.kendraranking.model.RescoreRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RescoreRequest.Builder,RescoreRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RescoreRequest
extends KendraRankingRequest
implements ToCopyableBuilder<RescoreRequest.Builder,RescoreRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RescoreRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RescoreRequest.Builder	builder()
List<Document>	documents() The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocuments() For responses, this returns true if the service returned a value for the Documents property.
int	hashCode()
String	rescoreExecutionPlanId() The identifier of the rescore execution plan.
List<SdkField<?>>	sdkFields()
String	searchQuery() The input query from the search service.
static Class<? extends RescoreRequest.Builder>	serializableBuilderClass()
RescoreRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

rescoreExecutionPlanId

public final 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.

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.

searchQuery

public final String searchQuery()

The input query from the search service.

Returns:

The input query from the search service.

hasDocuments

public final boolean hasDocuments()

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

documents

public final List<Document> documents()

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

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

Returns:

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

toBuilder

public RescoreRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RescoreRequest.Builder,RescoreRequest>

Specified by:

toBuilder in class KendraRankingRequest

builder

public static RescoreRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RescoreRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo