Class ActionGroupInvocationInput

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

Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.

See Also:

  • Method Details

    • actionGroupName

      public final String actionGroupName()

      The name of the action group.

      Returns:
      The name of the action group.

    • apiPath

      public final String apiPath()

      The path to the API to call, based off the action group.

      Returns:
      The path to the API to call, based off the action group.

    • executionType

      public final ExecutionType executionType()

      How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

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

      Returns:
      How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
      See Also:

    • executionTypeAsString

      public final String executionTypeAsString()

      How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

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

      Returns:
      How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
      See Also:

    • function

      public final String function()

      The function in the action group to call.

      Returns:
      The function in the action group to call.

    • invocationId

      public final String invocationId()

      The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

      Returns:
      The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

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

    • parameters

      public final List<Parameter> parameters()

      The parameters in the Lambda input event.

      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:
      The parameters in the Lambda input event.

    • requestBody

      public final RequestBody requestBody()

      The parameters in the request body for the Lambda input event.

      Returns:
      The parameters in the request body for the Lambda input event.

    • verb

      public final String verb()

      The API method being used, based off the action group.

      Returns:
      The API method being used, based off the action group.

    • toBuilder

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

    • builder

      public static ActionGroupInvocationInput.Builder builder()

    • serializableBuilderClass

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

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