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

Class ParameterDetail

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.ParameterDetail

All Implemented Interfaces:

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

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

Contains details about a parameter in a function for an action group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParameterDetail.Builder

Method Summary

Modifier and Type	Method	Description
static ParameterDetail.Builder	builder()
String	description()	A description of the parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	required()	Whether the parameter is required for the agent to complete the function for action group invocation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ParameterDetail.Builder>	serializableBuilderClass()
ParameterDetail.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ParameterType	type()	The data type of the parameter.
String	typeAsString()	The data type of the parameter.

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

description

public final String description()

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Returns:

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

required

public final Boolean required()

Whether the parameter is required for the agent to complete the function for action group invocation.

Returns:

Whether the parameter is required for the agent to complete the function for action group invocation.

type

public final ParameterType type()

The data type of the parameter.

If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The data type of the parameter.

See Also:

ParameterType

typeAsString

public final String typeAsString()

The data type of the parameter.

If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The data type of the parameter.

See Also:

ParameterType

toBuilder

public ParameterDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParameterDetail.Builder,ParameterDetail>

builder

public static ParameterDetail.Builder builder()

serializableBuilderClass

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

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