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

Class OptimizedPrompt

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.OptimizedPrompt

All Implemented Interfaces:

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

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

Contains information about the optimized prompt.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OptimizedPrompt.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static OptimizedPrompt	fromTextPrompt(Consumer<TextPrompt.Builder> textPrompt)	Create an instance of this class with textPrompt() initialized to the given value.
static OptimizedPrompt	fromTextPrompt(TextPrompt textPrompt)	Create an instance of this class with textPrompt() 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 OptimizedPrompt.Builder>	serializableBuilderClass()
final TextPrompt	textPrompt()	Contains information about the text in the prompt that was optimized.
OptimizedPrompt.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
OptimizedPrompt.Type	type()	Retrieve an enum value representing which member of this object is populated.

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 Details

textPrompt

public final TextPrompt textPrompt()

Contains information about the text in the prompt that was optimized.

Returns:

Contains information about the text in the prompt that was optimized.

toBuilder

public OptimizedPrompt.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OptimizedPrompt.Builder,OptimizedPrompt>

builder

public static OptimizedPrompt.Builder builder()

serializableBuilderClass

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

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)

fromTextPrompt

public static OptimizedPrompt fromTextPrompt(TextPrompt textPrompt)

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

Contains information about the text in the prompt that was optimized.

Parameters:

textPrompt - Contains information about the text in the prompt that was optimized.

fromTextPrompt

public static OptimizedPrompt fromTextPrompt(Consumer<TextPrompt.Builder> textPrompt)

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

Contains information about the text in the prompt that was optimized.

Parameters:

textPrompt - Contains information about the text in the prompt that was optimized.

type

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo