Package software.amazon.awssdk.services.kendra.model

Class FeaturedResultsSetSummary

java.lang.Object
software.amazon.awssdk.services.kendra.model.FeaturedResultsSetSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FeaturedResultsSetSummary.Builder,FeaturedResultsSetSummary>
@Generated("software.amazon.awssdk:codegen") public final class FeaturedResultsSetSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FeaturedResultsSetSummary.Builder,FeaturedResultsSetSummary>

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.

See Also:

  • Method Details

    • 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.

    • 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:

    • 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:

    • 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 FeaturedResultsSetSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FeaturedResultsSetSummary.Builder,FeaturedResultsSetSummary>
      Returns:
      a builder for type T

    • builder

      public static FeaturedResultsSetSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FeaturedResultsSetSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.