Class FunctionSchema
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FunctionSchema.Builder,
FunctionSchema>
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
This data type is used in the following API operations:
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionstatic FunctionSchema.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static FunctionSchema
fromFunctions
(List<Function> functions) Create an instance of this class withfunctions()
initialized to the given value.A list of functions that each define an action in the action group.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Functions property.final int
hashCode()
static Class
<? extends FunctionSchema.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FunctionSchema.Builder,
FunctionSchema> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromFunctions
Create an instance of this class withfunctions()
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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beFunctionSchema.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 beFunctionSchema.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-