@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FeaturedResultsSetSummary extends Object implements Serializable, Cloneable, StructuredPojo
Summary information for a set of featured 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 |
---|
FeaturedResultsSetSummary() |
Modifier and Type | Method and Description |
---|---|
FeaturedResultsSetSummary |
clone() |
boolean |
equals(Object obj) |
Long |
getCreationTimestamp()
The Unix timestamp when the set of featured results was created.
|
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.
|
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 |
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 |
setStatus(String status)
The current status of the set of featured results.
|
String |
toString()
Returns a string representation of this object.
|
FeaturedResultsSetSummary |
withCreationTimestamp(Long creationTimestamp)
The Unix timestamp when the set of featured results was created.
|
FeaturedResultsSetSummary |
withFeaturedResultsSetId(String featuredResultsSetId)
The identifier of the set of featured results.
|
FeaturedResultsSetSummary |
withFeaturedResultsSetName(String featuredResultsSetName)
The name for the set of featured results.
|
FeaturedResultsSetSummary |
withLastUpdatedTimestamp(Long lastUpdatedTimestamp)
The Unix timestamp when the set of featured results was last updated.
|
FeaturedResultsSetSummary |
withStatus(FeaturedResultsSetStatus status)
The current status of the set of featured results.
|
FeaturedResultsSetSummary |
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 FeaturedResultsSetSummary 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 FeaturedResultsSetSummary withFeaturedResultsSetName(String featuredResultsSetName)
The name for the set of featured results.
featuredResultsSetName
- The name 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 FeaturedResultsSetSummary 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 FeaturedResultsSetSummary 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 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 FeaturedResultsSetSummary 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 FeaturedResultsSetSummary 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 FeaturedResultsSetSummary clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.