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

Class FunctionSchema

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FunctionSchema

All Implemented Interfaces:

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

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

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FunctionSchema.Builder
static class	FunctionSchema.Type

Method Summary

Modifier and Type	Method	Description
static FunctionSchema.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static FunctionSchema	fromFunctions(List<FunctionDefinition> functions)	Create an instance of this class with functions() initialized to the given value.
List<FunctionDefinition>	functions()	A list of functions that each define an action in the action group.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFunctions()	For responses, this returns true if the service returned a value for the Functions property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FunctionSchema.Builder>	serializableBuilderClass()
FunctionSchema.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
FunctionSchema.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 Detail

hasFunctions

public final boolean hasFunctions()

For responses, this returns true if the service returned a value for the Functions 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.

functions

public final List<FunctionDefinition> functions()

A list of functions that each define an action in the action group.

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 hasFunctions() method.

Returns:

A list of functions that each define an action in the action group.

toBuilder

public FunctionSchema.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FunctionSchema.Builder,FunctionSchema>

builder

public static FunctionSchema.Builder builder()

serializableBuilderClass

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

fromFunctions

public static FunctionSchema fromFunctions(List<FunctionDefinition> functions)

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

A list of functions that each define an action in the action group.

Parameters:

functions - A list of functions that each define an action in the action group.

type

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