Class ActionGroupExecutor

java.lang.Object
software.amazon.awssdk.services.bedrockagentruntime.model.ActionGroupExecutor
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ActionGroupExecutor.Builder,ActionGroupExecutor>
@Generated("software.amazon.awssdk:codegen") public final class ActionGroupExecutor extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionGroupExecutor.Builder,ActionGroupExecutor>

Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

See Also:

  • Method Details

    • lambda

      public final String lambda()

      The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

      Returns:
      The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

    • customControl

      public final CustomControlMethod customControl()

      To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.

      If the service returns an enum value that is not available in the current SDK version, customControl will return CustomControlMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from customControlAsString().

      Returns:
      To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
      See Also:

    • customControlAsString

      public final String customControlAsString()

      To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.

      If the service returns an enum value that is not available in the current SDK version, customControl will return CustomControlMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from customControlAsString().

      Returns:
      To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
      See Also:

    • toBuilder

      public ActionGroupExecutor.Builder 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 interface ToCopyableBuilder<ActionGroupExecutor.Builder,ActionGroupExecutor>
      Returns:
      a builder for type T

    • builder

      public static ActionGroupExecutor.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ActionGroupExecutor.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • fromLambda

      public static ActionGroupExecutor fromLambda(String lambda)
      Create an instance of this class with lambda() initialized to the given value.

      The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

      Parameters:
      lambda - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

    • fromCustomControl

      public static ActionGroupExecutor fromCustomControl(String customControl)
      Create an instance of this class with customControlAsString() initialized to the given value.

      To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.

      Parameters:
      customControl - To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
      See Also:

    • fromCustomControl

      public static ActionGroupExecutor fromCustomControl(CustomControlMethod customControl)
      Create an instance of this class with customControlAsString() initialized to the given value.

      To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.

      Parameters:
      customControl - To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
      See Also:

    • type

      public ActionGroupExecutor.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 ActionGroupExecutor.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 ActionGroupExecutor.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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.