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

Class CreateQuerySuggestionsBlockListRequest

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

  • Method Details

    • indexId

      public final String indexId()

      The identifier of the index you want to create a query suggestions block list for.

      Returns:
      The identifier of the index you want to create a query suggestions block list for.

    • name

      public final String name()

      A name for the block list.

      For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

      Returns:
      A name for the block list.

      For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

    • description

      public final String description()

      A description for the block list.

      For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

      Returns:
      A description for the block list.

      For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

    • sourceS3Path

      public final S3Path sourceS3Path()

      The 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:
      The 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.

    • clientToken

      public final String clientToken()

      A token that you provide to identify the request to create a query suggestions block list.

      Returns:
      A token that you provide to identify the request to create a query suggestions block list.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

      Returns:
      A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • toBuilder

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

    • builder

      public static CreateQuerySuggestionsBlockListRequest.Builder builder()

    • serializableBuilderClass

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