Class RetrieveResult

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

A single result from a content retrieval operation.

See Also:

  • Method Details

    • associationId

      public final String associationId()

      The identifier of the assistant association for the retrieved result.

      Returns:
      The identifier of the assistant association for the retrieved result.

    • sourceId

      public final String sourceId()

      The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.

      Returns:
      The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.

    • referenceType

      public final ReferenceType referenceType()

      A type to define the KB origin of a retrieved content.

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

      Returns:
      A type to define the KB origin of a retrieved content.
      See Also:

    • referenceTypeAsString

      public final String referenceTypeAsString()

      A type to define the KB origin of a retrieved content.

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

      Returns:
      A type to define the KB origin of a retrieved content.
      See Also:

    • contentText

      public final String contentText()

      The text content of the retrieved result.

      Returns:
      The text content of the retrieved result.

    • toBuilder

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

    • builder

      public static RetrieveResult.Builder builder()

    • serializableBuilderClass

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