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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFeaturedDocumentWithMetadata.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FeaturedDocumentWithMetadata.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The identifier of the featured document with its metadata.List<SdkField<?>>sdkFields()static Class<? extends FeaturedDocumentWithMetadata.Builder>serializableBuilderClass()Stringtitle()The main title of the featured document.FeaturedDocumentWithMetadata.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringuri()The source URI location of the featured document.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FeaturedDocumentWithMetadata.Builder,FeaturedDocumentWithMetadata>
-
builder
public static FeaturedDocumentWithMetadata.Builder builder()
-
serializableBuilderClass
public static Class<? extends FeaturedDocumentWithMetadata.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-