Class FeaturedDocumentWithMetadata

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

A featured document with its metadata information. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

      Returns:
      The identifier of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

    • title

      public final String title()

      The main title of the featured document.

      Returns:
      The main title of the featured document.

    • uri

      public final String uri()

      The source URI location of the featured document.

      Returns:
      The source URI location of the featured document.

    • toBuilder

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

    • builder

      public static FeaturedDocumentWithMetadata.Builder builder()

    • serializableBuilderClass

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