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

Class RetrieveResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse
software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RetrieveResponse.Builder,RetrieveResponse>
@Generated("software.amazon.awssdk:codegen") public final class RetrieveResponse extends BedrockAgentRuntimeResponse implements ToCopyableBuilder<RetrieveResponse.Builder,RetrieveResponse>

  • Method Details

    • guardrailAction

      public final GuadrailAction guardrailAction()

      Specifies if there is a guardrail intervention in the response.

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

      Returns:
      Specifies if there is a guardrail intervention in the response.
      See Also:

    • guardrailActionAsString

      public final String guardrailActionAsString()

      Specifies if there is a guardrail intervention in the response.

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

      Returns:
      Specifies if there is a guardrail intervention in the response.
      See Also:

    • nextToken

      public final String nextToken()

      If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

      Returns:
      If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

    • hasRetrievalResults

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

    • retrievalResults

      public final List<KnowledgeBaseRetrievalResult> retrievalResults()

      A list of results from querying the knowledge base.

      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 hasRetrievalResults() method.

      Returns:
      A list of results from querying the knowledge base.

    • toBuilder

      public RetrieveResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<RetrieveResponse.Builder,RetrieveResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static RetrieveResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RetrieveResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • 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