Class QuerySuggestionsBlockListSummary

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

Summary information on a query suggestions block list.

This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of a block list.

      Returns:
      The identifier of a block list.

    • name

      public final String name()

      The name of the block list.

      Returns:
      The name of the block list.

    • status

      public final QuerySuggestionsBlockListStatus status()

      The status of the block list.

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

      Returns:
      The status of the block list.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the block list.

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

      Returns:
      The status of the block list.
      See Also:

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when the block list was created.

      Returns:
      The Unix timestamp when the block list was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when the block list was last updated.

      Returns:
      The Unix timestamp when the block list was last updated.

    • itemCount

      public final Integer itemCount()

      The number of items in the block list file.

      Returns:
      The number of items in the block list file.

    • toBuilder

      public QuerySuggestionsBlockListSummary.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<QuerySuggestionsBlockListSummary.Builder,QuerySuggestionsBlockListSummary>
      Returns:
      a builder for type T

    • builder

      public static QuerySuggestionsBlockListSummary.Builder builder()

    • serializableBuilderClass

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