Package software.amazon.awssdk.services.bedrockagentcore.model

Class SystemPromptConfig

java.lang.Object

software.amazon.awssdk.services.bedrockagentcore.model.SystemPromptConfig

All Implemented Interfaces:

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

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

The system prompt input, either as inline text or from a configuration bundle.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SystemPromptConfig.Builder	builder()
final SystemPromptConfigurationBundle	configurationBundle()	The system prompt sourced from a configuration bundle version.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static SystemPromptConfig	fromConfigurationBundle(Consumer<SystemPromptConfigurationBundle.Builder> configurationBundle)	Create an instance of this class with configurationBundle() initialized to the given value.
static SystemPromptConfig	fromConfigurationBundle(SystemPromptConfigurationBundle configurationBundle)	Create an instance of this class with configurationBundle() initialized to the given value.
static SystemPromptConfig	fromText(String text)	Create an instance of this class with text() 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 SystemPromptConfig.Builder>	serializableBuilderClass()
final String	text()	The system prompt text provided inline.
SystemPromptConfig.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
SystemPromptConfig.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

text

public final String text()

The system prompt text provided inline.

Returns:

The system prompt text provided inline.

configurationBundle

public final SystemPromptConfigurationBundle configurationBundle()

The system prompt sourced from a configuration bundle version.

Returns:

The system prompt sourced from a configuration bundle version.

toBuilder

public SystemPromptConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SystemPromptConfig.Builder,SystemPromptConfig>

builder

public static SystemPromptConfig.Builder builder()

serializableBuilderClass

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

fromText

public static SystemPromptConfig fromText(String text)

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

The system prompt text provided inline.

Parameters:

text - The system prompt text provided inline.

fromConfigurationBundle

public static SystemPromptConfig fromConfigurationBundle(SystemPromptConfigurationBundle configurationBundle)

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

The system prompt sourced from a configuration bundle version.

Parameters:

configurationBundle - The system prompt sourced from a configuration bundle version.

fromConfigurationBundle

public static SystemPromptConfig fromConfigurationBundle(Consumer<SystemPromptConfigurationBundle.Builder> configurationBundle)

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

The system prompt sourced from a configuration bundle version.

Parameters:

configurationBundle - The system prompt sourced from a configuration bundle version.

type

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