software.amazon.awssdk.services.kendra.model

Class FeaturedResultsSet

java.lang.Object

software.amazon.awssdk.services.kendra.model.FeaturedResultsSet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FeaturedResultsSet.Builder,FeaturedResultsSet>

@Generated(value="software.amazon.awssdk:codegen")
public final class FeaturedResultsSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FeaturedResultsSet.Builder,FeaturedResultsSet>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FeaturedResultsSet.Builder

Method Summary

Modifier and Type	Method and Description
static FeaturedResultsSet.Builder	builder()
Long	creationTimestamp() The Unix timestamp when the set of featured results was created.
String	description() The description for the set of featured results.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FeaturedDocument>	featuredDocuments() The list of document IDs for the documents you want to feature at the top of the search results page.
String	featuredResultsSetId() The identifier of the set of featured results.
String	featuredResultsSetName() The name for the set of featured results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFeaturedDocuments() For responses, this returns true if the service returned a value for the FeaturedDocuments property.
int	hashCode()
boolean	hasQueryTexts() For responses, this returns true if the service returned a value for the QueryTexts property.
Long	lastUpdatedTimestamp() The Unix timestamp when the set of featured results was last updated.
List<String>	queryTexts() The list of queries for featuring results.
List<SdkField<?>>	sdkFields()
static Class<? extends FeaturedResultsSet.Builder>	serializableBuilderClass()
FeaturedResultsSetStatus	status() The current status of the set of featured results.
String	statusAsString() The current status of the set of featured results.
FeaturedResultsSet.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

featuredResultsSetId

public final String featuredResultsSetId()

The identifier of the set of featured results.

Returns:

The identifier of the set of featured results.

featuredResultsSetName

public final String featuredResultsSetName()

The name for the set of featured results.

Returns:

The name for the set of featured results.

description

public final String description()

The description for the set of featured results.

Returns:

The description for the set of featured results.

status

public final 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.

If the service returns an enum value that is not available in the current SDK version, status will return FeaturedResultsSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

FeaturedResultsSetStatus

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return FeaturedResultsSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

FeaturedResultsSetStatus

hasQueryTexts

public final boolean hasQueryTexts()

For responses, this returns true if the service returned a value for the QueryTexts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

queryTexts

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryTexts() method.

Returns:

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.

hasFeaturedDocuments

public final boolean hasFeaturedDocuments()

For responses, this returns true if the service returned a value for the FeaturedDocuments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

featuredDocuments

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeaturedDocuments() method.

Returns:

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.

lastUpdatedTimestamp

public final Long lastUpdatedTimestamp()

The Unix timestamp when the set of featured results was last updated.

Returns:

The Unix timestamp when the set of featured results was last updated.

creationTimestamp

public final Long creationTimestamp()

The Unix timestamp when the set of featured results was created.

Returns:

The Unix timestamp when the set of featured results was created.

toBuilder

public FeaturedResultsSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FeaturedResultsSet.Builder,FeaturedResultsSet>

builder

public static FeaturedResultsSet.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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