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

Class ReturnControlPayload

java.lang.Object
software.amazon.awssdk.services.bedrockagentruntime.model.ReturnControlPayload
All Implemented Interfaces:
Serializable, SdkPojo, ResponseStream, ToCopyableBuilder<ReturnControlPayload.Builder,ReturnControlPayload>
Direct Known Subclasses:
DefaultReturnControl
@Generated("software.amazon.awssdk:codegen") public class ReturnControlPayload extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReturnControlPayload.Builder,ReturnControlPayload>, ResponseStream

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the following API operations:

See Also:

  • Constructor Details

  • Method Details

    • 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 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.

    • 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 ReturnControlPayload.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ReturnControlPayload.Builder,ReturnControlPayload>

    • builder

      public static ReturnControlPayload.Builder builder()

    • serializableBuilderClass

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

    • copy

      public final ReturnControlPayload copy(Consumer<? super ReturnControlPayload.Builder> modifier)
      Specified by:
      copy in interface ToCopyableBuilder<ReturnControlPayload.Builder,ReturnControlPayload>

    • 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

    • accept

      public void accept(InvokeAgentResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of ReturnControlPayload.
      Specified by:
      accept in interface ResponseStream
      Parameters:
      visitor - Visitor to invoke.