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

Class DescribeFeaturedResultsSetResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kendra.model.KendraResponse
software.amazon.awssdk.services.kendra.model.DescribeFeaturedResultsSetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeFeaturedResultsSetResponse.Builder,DescribeFeaturedResultsSetResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeFeaturedResultsSetResponse extends KendraResponse implements ToCopyableBuilder<DescribeFeaturedResultsSetResponse.Builder,DescribeFeaturedResultsSetResponse>

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

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

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

    • 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. For more information on the list of queries, see FeaturedResultsSet.

      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. For more information on the list of queries, see FeaturedResultsSet.

    • hasFeaturedDocumentsWithMetadata

      public final boolean hasFeaturedDocumentsWithMetadata()
      For responses, this returns true if the service returned a value for the FeaturedDocumentsWithMetadata 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.

    • featuredDocumentsWithMetadata

      public final List<FeaturedDocumentWithMetadata> featuredDocumentsWithMetadata()

      The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

      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 hasFeaturedDocumentsWithMetadata() method.

      Returns:
      The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

    • hasFeaturedDocumentsMissing

      public final boolean hasFeaturedDocumentsMissing()
      For responses, this returns true if the service returned a value for the FeaturedDocumentsMissing 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.

    • featuredDocumentsMissing

      public final List<FeaturedDocumentMissing> featuredDocumentsMissing()

      The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

      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 hasFeaturedDocumentsMissing() method.

      Returns:
      The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

    • lastUpdatedTimestamp

      public final Long lastUpdatedTimestamp()

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

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

    • creationTimestamp

      public final Long creationTimestamp()

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

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

    • toBuilder

      public DescribeFeaturedResultsSetResponse.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<DescribeFeaturedResultsSetResponse.Builder,DescribeFeaturedResultsSetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeFeaturedResultsSetResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeFeaturedResultsSetResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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