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

Class UpdateQuerySuggestionsBlockListRequest

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

  • 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 you want to update.

      Returns:
      The identifier of the block list you want to update.

    • name

      public final String name()

      A new name for the block list.

      Returns:
      A new name for the block list.

    • description

      public final String description()

      A new description for the block list.

      Returns:
      A new description for the block list.

    • sourceS3Path

      public final S3Path sourceS3Path()

      The S3 path where your block list text file sits in S3.

      If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

      If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

      Returns:
      The S3 path where your block list text file sits in S3.

      If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

      If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

    • roleArn

      public final String roleArn()

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

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

    • toBuilder

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

    • builder

      public static UpdateQuerySuggestionsBlockListRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.