Class ApiResult

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

Contains information about the API operation that was called from the action group and the response body that was returned.

This data type is used in the following API operations:

See Also:

  • Method Details

    • actionGroup

      public final String actionGroup()

      The action group that the API operation belongs to.

      Returns:
      The action group that the API operation belongs to.

    • agentId

      public final String agentId()

      The agent's ID.

      Returns:
      The agent's ID.

    • apiPath

      public final String apiPath()

      The path to the API operation.

      Returns:
      The path to the API operation.

    • confirmationState

      public final ConfirmationState confirmationState()

      Controls the API operations or functions to invoke based on the user confirmation.

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

      Returns:
      Controls the API operations or functions to invoke based on the user confirmation.
      See Also:

    • confirmationStateAsString

      public final String confirmationStateAsString()

      Controls the API operations or functions to invoke based on the user confirmation.

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

      Returns:
      Controls the API operations or functions to invoke based on the user confirmation.
      See Also:

    • httpMethod

      public final String httpMethod()

      The HTTP method for the API operation.

      Returns:
      The HTTP method for the API operation.

    • httpStatusCode

      public final Integer httpStatusCode()

      http status code from API execution response (for example: 200, 400, 500).

      Returns:
      http status code from API execution response (for example: 200, 400, 500).

    • hasResponseBody

      public final boolean hasResponseBody()
      For responses, this returns true if the service returned a value for the ResponseBody 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.

    • responseBody

      public final Map<String,ContentBody> responseBody()

      The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda 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 hasResponseBody() method.

      Returns:
      The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

    • responseState

      public final ResponseState responseState()

      Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

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

      Returns:
      Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
      See Also:

    • responseStateAsString

      public final String responseStateAsString()

      Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

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

      Returns:
      Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
      See Also:

    • toBuilder

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

    • builder

      public static ApiResult.Builder builder()

    • serializableBuilderClass

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