Class InlineAgentReturnControlPayload
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockagentruntime.model.InlineAgentReturnControlPayload
-
- All Implemented Interfaces:
Serializable,SdkPojo,InlineAgentResponseStream,ToCopyableBuilder<InlineAgentReturnControlPayload.Builder,InlineAgentReturnControlPayload>
- Direct Known Subclasses:
DefaultReturnControl
@Generated("software.amazon.awssdk:codegen") public class InlineAgentReturnControlPayload extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InlineAgentReturnControlPayload.Builder,InlineAgentReturnControlPayload>, InlineAgentResponseStream
Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the InvokeAgent response API operation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceInlineAgentReturnControlPayload.Builderprotected static classInlineAgentReturnControlPayload.BuilderImpl-
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.InlineAgentResponseStream
InlineAgentResponseStream.EventType
-
-
Field Summary
-
Fields inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.InlineAgentResponseStream
UNKNOWN
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedInlineAgentReturnControlPayload(InlineAgentReturnControlPayload.BuilderImpl builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(InvokeInlineAgentResponseHandler.Visitor visitor)Calls the appropriate visit method depending on the subtype ofInlineAgentReturnControlPayload.static InlineAgentReturnControlPayload.Builderbuilder()InlineAgentReturnControlPayloadcopy(Consumer<? super InlineAgentReturnControlPayload.Builder> modifier)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasInvocationInputs()For responses, this returns true if the service returned a value for the InvocationInputs property.StringinvocationId()The identifier of the action group invocation.List<InvocationInputMember>invocationInputs()A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends InlineAgentReturnControlPayload.Builder>serializableBuilderClass()InlineAgentReturnControlPayload.BuildertoBuilder()StringtoString()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.services.bedrockagentruntime.model.InlineAgentResponseStream
sdkEventType
-
-
-
-
Constructor Detail
-
InlineAgentReturnControlPayload
protected InlineAgentReturnControlPayload(InlineAgentReturnControlPayload.BuilderImpl builder)
-
-
Method Detail
-
invocationId
public final String invocationId()
The identifier of the action group invocation.
- Returns:
- The identifier of the action group invocation.
-
hasInvocationInputs
public final boolean hasInvocationInputs()
For responses, this returns true if the service returned a value for the InvocationInputs 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.
-
invocationInputs
public final List<InvocationInputMember> invocationInputs()
A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
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
hasInvocationInputs()method.- Returns:
- A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
-
toBuilder
public InlineAgentReturnControlPayload.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<InlineAgentReturnControlPayload.Builder,InlineAgentReturnControlPayload>
-
builder
public static InlineAgentReturnControlPayload.Builder builder()
-
serializableBuilderClass
public static Class<? extends InlineAgentReturnControlPayload.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
copy
public final InlineAgentReturnControlPayload copy(Consumer<? super InlineAgentReturnControlPayload.Builder> modifier)
- Specified by:
copyin interfaceToCopyableBuilder<InlineAgentReturnControlPayload.Builder,InlineAgentReturnControlPayload>
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
accept
public void accept(InvokeInlineAgentResponseHandler.Visitor visitor)
Calls the appropriate visit method depending on the subtype ofInlineAgentReturnControlPayload.- Specified by:
acceptin interfaceInlineAgentResponseStream- Parameters:
visitor- Visitor to invoke.
-
-