Class RecommendationResult

java.lang.Object

software.amazon.awssdk.services.bedrockagentcore.model.RecommendationResult

All Implemented Interfaces:

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

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

The result of a recommendation, containing the optimized output.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecommendationResult.Builder
static enum	RecommendationResult.Type

Method Summary

Modifier and Type	Method	Description
static RecommendationResult.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
static RecommendationResult	fromSystemPromptRecommendationResult(Consumer<SystemPromptRecommendationResult.Builder> systemPromptRecommendationResult)	Create an instance of this class with systemPromptRecommendationResult() initialized to the given value.
static RecommendationResult	fromSystemPromptRecommendationResult(SystemPromptRecommendationResult systemPromptRecommendationResult)	Create an instance of this class with systemPromptRecommendationResult() initialized to the given value.
static RecommendationResult	fromToolDescriptionRecommendationResult(Consumer<ToolDescriptionRecommendationResult.Builder> toolDescriptionRecommendationResult)	Create an instance of this class with toolDescriptionRecommendationResult() initialized to the given value.
static RecommendationResult	fromToolDescriptionRecommendationResult(ToolDescriptionRecommendationResult toolDescriptionRecommendationResult)	Create an instance of this class with toolDescriptionRecommendationResult() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends RecommendationResult.Builder>	serializableBuilderClass()
final SystemPromptRecommendationResult	systemPromptRecommendationResult()	The result of a system prompt recommendation.
RecommendationResult.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final ToolDescriptionRecommendationResult	toolDescriptionRecommendationResult()	The result of a tool description recommendation.
final String	toString()	Returns a string representation of this object.
RecommendationResult.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

systemPromptRecommendationResult

public final SystemPromptRecommendationResult systemPromptRecommendationResult()

The result of a system prompt recommendation.

Returns:

The result of a system prompt recommendation.

toolDescriptionRecommendationResult

public final ToolDescriptionRecommendationResult toolDescriptionRecommendationResult()

The result of a tool description recommendation.

Returns:

The result of a tool description recommendation.

toBuilder

public RecommendationResult.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RecommendationResult.Builder,RecommendationResult>

Returns:

a builder for type T

builder

public static RecommendationResult.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

fromSystemPromptRecommendationResult

public static RecommendationResult fromSystemPromptRecommendationResult(SystemPromptRecommendationResult systemPromptRecommendationResult)

Create an instance of this class with systemPromptRecommendationResult() initialized to the given value.

The result of a system prompt recommendation.

Parameters:

systemPromptRecommendationResult - The result of a system prompt recommendation.

fromSystemPromptRecommendationResult

public static RecommendationResult fromSystemPromptRecommendationResult(Consumer<SystemPromptRecommendationResult.Builder> systemPromptRecommendationResult)

Create an instance of this class with systemPromptRecommendationResult() initialized to the given value.

The result of a system prompt recommendation.

Parameters:

systemPromptRecommendationResult - The result of a system prompt recommendation.

fromToolDescriptionRecommendationResult

public static RecommendationResult fromToolDescriptionRecommendationResult(ToolDescriptionRecommendationResult toolDescriptionRecommendationResult)

Create an instance of this class with toolDescriptionRecommendationResult() initialized to the given value.

The result of a tool description recommendation.

Parameters:

toolDescriptionRecommendationResult - The result of a tool description recommendation.

fromToolDescriptionRecommendationResult

public static RecommendationResult fromToolDescriptionRecommendationResult(Consumer<ToolDescriptionRecommendationResult.Builder> toolDescriptionRecommendationResult)

Create an instance of this class with toolDescriptionRecommendationResult() initialized to the given value.

The result of a tool description recommendation.

Parameters:

toolDescriptionRecommendationResult - The result of a tool description recommendation.

type

public RecommendationResult.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RecommendationResult.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RecommendationResult.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.