Package software.amazon.awssdk.services.bedrockagentruntime.model

Class RerankResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse

software.amazon.awssdk.services.bedrockagentruntime.model.RerankResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RerankResponse.Builder,RerankResponse>

@Generated("software.amazon.awssdk:codegen")
public final class RerankResponse
extends BedrockAgentRuntimeResponse
implements ToCopyableBuilder<RerankResponse.Builder,RerankResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RerankResponse.Builder

Method Summary

Modifier and Type	Method	Description
static RerankResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResults()	For responses, this returns true if the service returned a value for the Results property.
String	nextToken()	If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.
List<RerankResult>	results()	An array of objects, each of which contains information about the results of reranking.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RerankResponse.Builder>	serializableBuilderClass()
RerankResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

nextToken

public final String nextToken()

If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.

Returns:

If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.

hasResults

public final boolean hasResults()

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

results

public final List<RerankResult> results()

An array of objects, each of which contains information about the results of reranking.

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

Returns:

An array of objects, each of which contains information about the results of reranking.

toBuilder

public RerankResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RerankResponse.Builder,RerankResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static RerankResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo