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

Class FunctionDefinition

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FunctionDefinition

All Implemented Interfaces:

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

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

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FunctionDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static FunctionDefinition.Builder	builder()
String	description()	A description of the function and its purpose.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
String	name()	A name for the function.
Map<String,ParameterDetail>	parameters()	The parameters that the agent elicits from the user to fulfill the function.
RequireConfirmation	requireConfirmation()	Contains information if user confirmation is required to invoke the function.
String	requireConfirmationAsString()	Contains information if user confirmation is required to invoke the function.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FunctionDefinition.Builder>	serializableBuilderClass()
FunctionDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 function and its purpose.

Returns:

A description of the function and its purpose.

name

public final String name()

A name for the function.

Returns:

A name for the function.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

parameters

public final Map<String,ParameterDetail> parameters()

The parameters that the agent elicits from the user to fulfill the function.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

Returns:

The parameters that the agent elicits from the user to fulfill the function.

requireConfirmation

public final RequireConfirmation requireConfirmation()

Contains information if user confirmation is required to invoke the function.

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

Returns:

Contains information if user confirmation is required to invoke the function.

See Also:

RequireConfirmation

requireConfirmationAsString

public final String requireConfirmationAsString()

Contains information if user confirmation is required to invoke the function.

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

Returns:

Contains information if user confirmation is required to invoke the function.

See Also:

RequireConfirmation

toBuilder

public FunctionDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FunctionDefinition.Builder,FunctionDefinition>

builder

public static FunctionDefinition.Builder builder()

serializableBuilderClass

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