Class RecommendationData

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

Information about the recommendation.

See Also:

  • Method Details

    • recommendationId

      public final String recommendationId()

      The identifier of the recommendation.

      Returns:
      The identifier of the recommendation.

    • document

      public final Document document()

      The recommended document.

      Returns:
      The recommended document.

    • relevanceScore

      public final Double relevanceScore()

      The relevance score of the recommendation.

      Returns:
      The relevance score of the recommendation.

    • relevanceLevel

      public final RelevanceLevel relevanceLevel()

      The relevance level of the recommendation.

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

      Returns:
      The relevance level of the recommendation.
      See Also:

    • relevanceLevelAsString

      public final String relevanceLevelAsString()

      The relevance level of the recommendation.

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

      Returns:
      The relevance level of the recommendation.
      See Also:

    • type

      public final RecommendationType type()

      The type of recommendation.

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

      Returns:
      The type of recommendation.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of recommendation.

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

      Returns:
      The type of recommendation.
      See Also:

    • data

      public final DataSummary data()

      Summary of the recommended content.

      Returns:
      Summary of the recommended content.

    • toBuilder

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

    • builder

      public static RecommendationData.Builder builder()

    • serializableBuilderClass

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