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

Class ToolDescriptionSource

java.lang.Object

software.amazon.awssdk.services.bedrockagentcore.model.ToolDescriptionSource

All Implemented Interfaces:

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

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

The source of tool descriptions, either inline text or from a configuration bundle.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

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

toolDescriptionText

public final ToolDescriptionTextInput toolDescriptionText()

Tool descriptions provided as inline text.

Returns:

Tool descriptions provided as inline text.

configurationBundle

public final ToolDescriptionConfigurationBundle configurationBundle()

Tool descriptions sourced from a configuration bundle version.

Returns:

Tool descriptions sourced from a configuration bundle version.

toBuilder

public ToolDescriptionSource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolDescriptionSource.Builder,ToolDescriptionSource>

builder

public static ToolDescriptionSource.Builder builder()

serializableBuilderClass

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

fromToolDescriptionText

public static ToolDescriptionSource fromToolDescriptionText(ToolDescriptionTextInput toolDescriptionText)

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

Tool descriptions provided as inline text.

Parameters:

toolDescriptionText - Tool descriptions provided as inline text.

fromToolDescriptionText

public static ToolDescriptionSource fromToolDescriptionText(Consumer<ToolDescriptionTextInput.Builder> toolDescriptionText)

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

Tool descriptions provided as inline text.

Parameters:

toolDescriptionText - Tool descriptions provided as inline text.

fromConfigurationBundle

public static ToolDescriptionSource fromConfigurationBundle(ToolDescriptionConfigurationBundle configurationBundle)

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

Tool descriptions sourced from a configuration bundle version.

Parameters:

configurationBundle - Tool descriptions sourced from a configuration bundle version.

fromConfigurationBundle

public static ToolDescriptionSource fromConfigurationBundle(Consumer<ToolDescriptionConfigurationBundle.Builder> configurationBundle)

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

Tool descriptions sourced from a configuration bundle version.

Parameters:

configurationBundle - Tool descriptions sourced from a configuration bundle version.

type

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