@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FeaturedResultsSet extends Object implements Serializable, Cloneable, StructuredPojo
A set of featured results that are displayed at the top of your search results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
Constructor and Description |
---|
FeaturedResultsSet() |
Modifier and Type | Method and Description |
---|---|
FeaturedResultsSet |
clone() |
boolean |
equals(Object obj) |
Long |
getCreationTimestamp()
The Unix timestamp when the set of featured results was created.
|
String |
getDescription()
The description for the set of featured results.
|
List<FeaturedDocument> |
getFeaturedDocuments()
The list of document IDs for the documents you want to feature at the top of the search results page.
|
String |
getFeaturedResultsSetId()
The identifier of the set of featured results.
|
String |
getFeaturedResultsSetName()
The name for the set of featured results.
|
Long |
getLastUpdatedTimestamp()
The Unix timestamp when the set of featured results was last updated.
|
List<String> |
getQueryTexts()
The list of queries for featuring results.
|
String |
getStatus()
The current status of the set of featured results.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreationTimestamp(Long creationTimestamp)
The Unix timestamp when the set of featured results was created.
|
void |
setDescription(String description)
The description for the set of featured results.
|
void |
setFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments)
The list of document IDs for the documents you want to feature at the top of the search results page.
|
void |
setFeaturedResultsSetId(String featuredResultsSetId)
The identifier of the set of featured results.
|
void |
setFeaturedResultsSetName(String featuredResultsSetName)
The name for the set of featured results.
|
void |
setLastUpdatedTimestamp(Long lastUpdatedTimestamp)
The Unix timestamp when the set of featured results was last updated.
|
void |
setQueryTexts(Collection<String> queryTexts)
The list of queries for featuring results.
|
void |
setStatus(String status)
The current status of the set of featured results.
|
String |
toString()
Returns a string representation of this object.
|
FeaturedResultsSet |
withCreationTimestamp(Long creationTimestamp)
The Unix timestamp when the set of featured results was created.
|
FeaturedResultsSet |
withDescription(String description)
The description for the set of featured results.
|
FeaturedResultsSet |
withFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments)
The list of document IDs for the documents you want to feature at the top of the search results page.
|
FeaturedResultsSet |
withFeaturedDocuments(FeaturedDocument... featuredDocuments)
The list of document IDs for the documents you want to feature at the top of the search results page.
|
FeaturedResultsSet |
withFeaturedResultsSetId(String featuredResultsSetId)
The identifier of the set of featured results.
|
FeaturedResultsSet |
withFeaturedResultsSetName(String featuredResultsSetName)
The name for the set of featured results.
|
FeaturedResultsSet |
withLastUpdatedTimestamp(Long lastUpdatedTimestamp)
The Unix timestamp when the set of featured results was last updated.
|
FeaturedResultsSet |
withQueryTexts(Collection<String> queryTexts)
The list of queries for featuring results.
|
FeaturedResultsSet |
withQueryTexts(String... queryTexts)
The list of queries for featuring results.
|
FeaturedResultsSet |
withStatus(FeaturedResultsSetStatus status)
The current status of the set of featured results.
|
FeaturedResultsSet |
withStatus(String status)
The current status of the set of featured results.
|
public void setFeaturedResultsSetId(String featuredResultsSetId)
The identifier of the set of featured results.
featuredResultsSetId
- The identifier of the set of featured results.public String getFeaturedResultsSetId()
The identifier of the set of featured results.
public FeaturedResultsSet withFeaturedResultsSetId(String featuredResultsSetId)
The identifier of the set of featured results.
featuredResultsSetId
- The identifier of the set of featured results.public void setFeaturedResultsSetName(String featuredResultsSetName)
The name for the set of featured results.
featuredResultsSetName
- The name for the set of featured results.public String getFeaturedResultsSetName()
The name for the set of featured results.
public FeaturedResultsSet withFeaturedResultsSetName(String featuredResultsSetName)
The name for the set of featured results.
featuredResultsSetName
- The name for the set of featured results.public void setDescription(String description)
The description for the set of featured results.
description
- The description for the set of featured results.public String getDescription()
The description for the set of featured results.
public FeaturedResultsSet withDescription(String description)
The description for the set of featured results.
description
- The description for the set of featured results.public void setStatus(String status)
The current status of the set of featured results. When the value is ACTIVE
, featured results are
ready for use. You can still configure your settings before setting the status to ACTIVE
. You can
set the status to ACTIVE
or INACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
results set for each index, whether the status is ACTIVE
or INACTIVE
.
status
- The current status of the set of featured results. When the value is ACTIVE
, featured results
are ready for use. You can still configure your settings before setting the status to ACTIVE
.
You can set the status to ACTIVE
or INACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
featured results set for each index, whether the status is ACTIVE
or INACTIVE
.FeaturedResultsSetStatus
public String getStatus()
The current status of the set of featured results. When the value is ACTIVE
, featured results are
ready for use. You can still configure your settings before setting the status to ACTIVE
. You can
set the status to ACTIVE
or INACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
results set for each index, whether the status is ACTIVE
or INACTIVE
.
ACTIVE
, featured
results are ready for use. You can still configure your settings before setting the status to
ACTIVE
. You can set the status to ACTIVE
or INACTIVE
using the
UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
featured results set for each index, whether the status is ACTIVE
or INACTIVE
.FeaturedResultsSetStatus
public FeaturedResultsSet withStatus(String status)
The current status of the set of featured results. When the value is ACTIVE
, featured results are
ready for use. You can still configure your settings before setting the status to ACTIVE
. You can
set the status to ACTIVE
or INACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
results set for each index, whether the status is ACTIVE
or INACTIVE
.
status
- The current status of the set of featured results. When the value is ACTIVE
, featured results
are ready for use. You can still configure your settings before setting the status to ACTIVE
.
You can set the status to ACTIVE
or INACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
featured results set for each index, whether the status is ACTIVE
or INACTIVE
.FeaturedResultsSetStatus
public FeaturedResultsSet withStatus(FeaturedResultsSetStatus status)
The current status of the set of featured results. When the value is ACTIVE
, featured results are
ready for use. You can still configure your settings before setting the status to ACTIVE
. You can
set the status to ACTIVE
or INACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured
results set for each index, whether the status is ACTIVE
or INACTIVE
.
status
- The current status of the set of featured results. When the value is ACTIVE
, featured results
are ready for use. You can still configure your settings before setting the status to ACTIVE
.
You can set the status to ACTIVE
or INACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per
featured results set for each index, whether the status is ACTIVE
or INACTIVE
.FeaturedResultsSetStatus
public List<String> getQueryTexts()
The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public void setQueryTexts(Collection<String> queryTexts)
The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
queryTexts
- The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public FeaturedResultsSet withQueryTexts(String... queryTexts)
The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
NOTE: This method appends the values to the existing list (if any). Use
setQueryTexts(java.util.Collection)
or withQueryTexts(java.util.Collection)
if you want to
override the existing values.
queryTexts
- The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public FeaturedResultsSet withQueryTexts(Collection<String> queryTexts)
The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
queryTexts
- The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public List<FeaturedDocument> getFeaturedDocuments()
The list of document IDs for the documents you want to feature at the top of the search results page. 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.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public void setFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments)
The list of document IDs for the documents you want to feature at the top of the search results page. 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.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
featuredDocuments
- The list of document IDs for the documents you want to feature at the top of the search results page. 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.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public FeaturedResultsSet withFeaturedDocuments(FeaturedDocument... featuredDocuments)
The list of document IDs for the documents you want to feature at the top of the search results page. 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.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
NOTE: This method appends the values to the existing list (if any). Use
setFeaturedDocuments(java.util.Collection)
or withFeaturedDocuments(java.util.Collection)
if
you want to override the existing values.
featuredDocuments
- The list of document IDs for the documents you want to feature at the top of the search results page. 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.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public FeaturedResultsSet withFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments)
The list of document IDs for the documents you want to feature at the top of the search results page. 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.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
featuredDocuments
- The list of document IDs for the documents you want to feature at the top of the search results page. 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.
You can add up to four featured documents. You can request to increase this limit by contacting Support.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
public void setLastUpdatedTimestamp(Long lastUpdatedTimestamp)
The Unix timestamp when the set of featured results was last updated.
lastUpdatedTimestamp
- The Unix timestamp when the set of featured results was last updated.public Long getLastUpdatedTimestamp()
The Unix timestamp when the set of featured results was last updated.
public FeaturedResultsSet withLastUpdatedTimestamp(Long lastUpdatedTimestamp)
The Unix timestamp when the set of featured results was last updated.
lastUpdatedTimestamp
- The Unix timestamp when the set of featured results was last updated.public void setCreationTimestamp(Long creationTimestamp)
The Unix timestamp when the set of featured results was created.
creationTimestamp
- The Unix timestamp when the set of featured results was created.public Long getCreationTimestamp()
The Unix timestamp when the set of featured results was created.
public FeaturedResultsSet withCreationTimestamp(Long creationTimestamp)
The Unix timestamp when the set of featured results was created.
creationTimestamp
- The Unix timestamp when the set of featured results was created.public String toString()
toString
in class Object
Object.toString()
public FeaturedResultsSet clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.