Class Highlight

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

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

See Also:

  • Method Details

    • beginOffset

      public final Integer beginOffset()

      The zero-based location in the response string where the highlight starts.

      Returns:
      The zero-based location in the response string where the highlight starts.

    • endOffset

      public final Integer endOffset()

      The zero-based location in the response string where the highlight ends.

      Returns:
      The zero-based location in the response string where the highlight ends.

    • topAnswer

      public final Boolean topAnswer()

      Indicates whether the response is the best response. True if this is the best response; otherwise, false.

      Returns:
      Indicates whether the response is the best response. True if this is the best response; otherwise, false.

    • type

      public final HighlightType type()

      The highlight type.

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

      Returns:
      The highlight type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The highlight type.

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

      Returns:
      The highlight type.
      See Also:

    • toBuilder

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

    • builder

      public static Highlight.Builder builder()

    • serializableBuilderClass

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