Class RetrieveError

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

An error returned for a single assistant association whose knowledge base retrieval failed during a Retrieve operation. The overall operation still succeeds and returns the results from the associations that were queried successfully.

See Also:

  • Method Details

    • associationId

      public final String associationId()

      The identifier of the assistant association whose knowledge base retrieval failed.

      Returns:
      The identifier of the assistant association whose knowledge base retrieval failed.

    • code

      public final RetrieveErrorCode code()

      The error code that categorizes the retrieval failure for the assistant association.

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

      Returns:
      The error code that categorizes the retrieval failure for the assistant association.
      See Also:

    • codeAsString

      public final String codeAsString()

      The error code that categorizes the retrieval failure for the assistant association.

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

      Returns:
      The error code that categorizes the retrieval failure for the assistant association.
      See Also:

    • message

      public final String message()

      A human-readable description of the retrieval failure for the assistant association.

      Returns:
      A human-readable description of the retrieval failure for the assistant association.

    • toBuilder

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

    • builder

      public static RetrieveError.Builder builder()

    • serializableBuilderClass

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