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

Class ListQuerySuggestionsBlockListsResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListQuerySuggestionsBlockListsResponse.Builder,ListQuerySuggestionsBlockListsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ListQuerySuggestionsBlockListsResponse
extends KendraResponse
implements ToCopyableBuilder<ListQuerySuggestionsBlockListsResponse.Builder,ListQuerySuggestionsBlockListsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListQuerySuggestionsBlockListsResponse.Builder

Method Summary

Modifier and Type	Method	Description
List<QuerySuggestionsBlockListSummary>	blockListSummaryItems()	Summary items for a block list.
static ListQuerySuggestionsBlockListsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlockListSummaryItems()	For responses, this returns true if the service returned a value for the BlockListSummaryItems property.
int	hashCode()
String	nextToken()	If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.
List<SdkField<?>>	sdkFields()
static Class<? extends ListQuerySuggestionsBlockListsResponse.Builder>	serializableBuilderClass()
ListQuerySuggestionsBlockListsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasBlockListSummaryItems

public final boolean hasBlockListSummaryItems()

For responses, this returns true if the service returned a value for the BlockListSummaryItems 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.

blockListSummaryItems

public final List<QuerySuggestionsBlockListSummary> blockListSummaryItems()

Summary items for a block list.

This includes summary items 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.

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

Returns:

Summary items for a block list.

This includes summary items 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.

nextToken

public final String nextToken()

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.

Returns:

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.

toBuilder

public ListQuerySuggestionsBlockListsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListQuerySuggestionsBlockListsResponse.Builder,ListQuerySuggestionsBlockListsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListQuerySuggestionsBlockListsResponse.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo