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

Class DescribeQuerySuggestionsBlockListResponse

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.DescribeQuerySuggestionsBlockListResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeQuerySuggestionsBlockListResponse.Builder,DescribeQuerySuggestionsBlockListResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeQuerySuggestionsBlockListResponse extends KendraResponse implements ToCopyableBuilder<DescribeQuerySuggestionsBlockListResponse.Builder,DescribeQuerySuggestionsBlockListResponse>

  • Method Details

    • indexId

      public final String indexId()

      The identifier of the index for the block list.

      Returns:
      The identifier of the index for the block list.

    • id

      public final String id()

      The identifier of the block list.

      Returns:
      The identifier of the block list.

    • name

      public final String name()

      The name of the block list.

      Returns:
      The name of the block list.

    • description

      public final String description()

      The description for the block list.

      Returns:
      The description for the block list.

    • status

      public final QuerySuggestionsBlockListStatus status()

      The current status of the block list. When the value is ACTIVE, the block list is ready for use.

      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 current status of the block list. When the value is ACTIVE, the block list is ready for use.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the block list. When the value is ACTIVE, the block list is ready for use.

      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 current status of the block list. When the value is ACTIVE, the block list is ready for use.
      See Also:

    • errorMessage

      public final String errorMessage()

      The error message containing details if there are issues processing the block list.

      Returns:
      The error message containing details if there are issues processing the block list.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when a block list for query suggestions was created.

      Returns:
      The Unix timestamp when a block list for query suggestions was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when a block list for query suggestions was last updated.

      Returns:
      The Unix timestamp when a block list for query suggestions was last updated.

    • sourceS3Path

      public final S3Path sourceS3Path()

      Shows the current S3 path to your block list text file in your S3 bucket.

      Each block word or phrase should be on a separate line in a text file.

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

      Returns:
      Shows the current S3 path to your block list text file in your S3 bucket.

      Each block word or phrase should be on a separate line in a text file.

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

    • itemCount

      public final Integer itemCount()

      The current number of valid, non-empty words or phrases in the block list text file.

      Returns:
      The current number of valid, non-empty words or phrases in the block list text file.

    • fileSizeBytes

      public final Long fileSizeBytes()

      The current size of the block list text file in S3.

      Returns:
      The current size of the block list text file in S3.

    • roleArn

      public final String roleArn()

      The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

      The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

      Returns:
      The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

      The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

    • toBuilder

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

    • builder

      public static DescribeQuerySuggestionsBlockListResponse.Builder builder()

    • serializableBuilderClass

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