@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FeaturedDocumentWithMetadata extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
FeaturedDocumentWithMetadata() |
Modifier and Type | Method and Description |
---|---|
FeaturedDocumentWithMetadata |
clone() |
boolean |
equals(Object obj) |
String |
getId()
The identifier of the featured document with its metadata.
|
String |
getTitle()
The main title of the featured document.
|
String |
getURI()
The source URI location of the featured document.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setId(String id)
The identifier of the featured document with its metadata.
|
void |
setTitle(String title)
The main title of the featured document.
|
void |
setURI(String uRI)
The source URI location of the featured document.
|
String |
toString()
Returns a string representation of this object.
|
FeaturedDocumentWithMetadata |
withId(String id)
The identifier of the featured document with its metadata.
|
FeaturedDocumentWithMetadata |
withTitle(String title)
The main title of the featured document.
|
FeaturedDocumentWithMetadata |
withURI(String uRI)
The source URI location of the featured document.
|
public void setId(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.
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.public String getId()
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.
public FeaturedDocumentWithMetadata withId(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.
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.public void setTitle(String title)
The main title of the featured document.
title
- The main title of the featured document.public String getTitle()
The main title of the featured document.
public FeaturedDocumentWithMetadata withTitle(String title)
The main title of the featured document.
title
- The main title of the featured document.public void setURI(String uRI)
The source URI location of the featured document.
uRI
- The source URI location of the featured document.public String getURI()
The source URI location of the featured document.
public FeaturedDocumentWithMetadata withURI(String uRI)
The source URI location of the featured document.
uRI
- The source URI location of the featured document.public String toString()
toString
in class Object
Object.toString()
public FeaturedDocumentWithMetadata clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.