Class FunctionInvocationInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FunctionInvocationInput.Builder,
FunctionInvocationInput>
Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
-
In the
returnControl
field of the InvokeAgent response
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The action group that the function belongs to.final ActionInvocationType
Contains information about the function to invoke,final String
Contains information about the function to invoke,final String
agentId()
The agent's ID.builder()
final String
The collaborator's name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
function()
The name of the function.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Parameters property.final List
<FunctionParameter> A list of parameters of the function.static Class
<? extends FunctionInvocationInput.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
actionGroup
The action group that the function belongs to.
- Returns:
- The action group that the function belongs to.
-
actionInvocationType
Contains information about the function to invoke,
If the service returns an enum value that is not available in the current SDK version,
actionInvocationType
will returnActionInvocationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionInvocationTypeAsString()
.- Returns:
- Contains information about the function to invoke,
- See Also:
-
actionInvocationTypeAsString
Contains information about the function to invoke,
If the service returns an enum value that is not available in the current SDK version,
actionInvocationType
will returnActionInvocationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionInvocationTypeAsString()
.- Returns:
- Contains information about the function to invoke,
- See Also:
-
agentId
-
collaboratorName
-
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 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. -
parameters
A list of parameters of 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:
- A list of parameters of the function.
-
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<FunctionInvocationInput.Builder,
FunctionInvocationInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-