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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceQuerySuggestionsBlockListSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static QuerySuggestionsBlockListSummary.Builderbuilder()InstantcreatedAt()The Unix timestamp when the block list was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The identifier of a block list.IntegeritemCount()The number of items in the block list file.Stringname()The name of the block list.List<SdkField<?>>sdkFields()static Class<? extends QuerySuggestionsBlockListSummary.Builder>serializableBuilderClass()QuerySuggestionsBlockListStatusstatus()The status of the block list.StringstatusAsString()The status of the block list.QuerySuggestionsBlockListSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The Unix timestamp when the block list was last updated.-
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
-
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,
statuswill returnQuerySuggestionsBlockListStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the block list.
- See Also:
QuerySuggestionsBlockListStatus
-
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,
statuswill returnQuerySuggestionsBlockListStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the block list.
- See Also:
QuerySuggestionsBlockListStatus
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<QuerySuggestionsBlockListSummary.Builder,QuerySuggestionsBlockListSummary>
-
builder
public static QuerySuggestionsBlockListSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends QuerySuggestionsBlockListSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-