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

Class GetQuerySuggestionsRequest

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

  • Method Details

    • indexId

      public final String indexId()

      The identifier of the index you want to get query suggestions from.

      Returns:
      The identifier of the index you want to get query suggestions from.

    • queryText

      public final String queryText()

      The text of a user's query to generate query suggestions.

      A query is suggested if the query prefix matches what a user starts to type as their query.

      Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

      Returns:
      The text of a user's query to generate query suggestions.

      A query is suggested if the query prefix matches what a user starts to type as their query.

      Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

    • maxSuggestionsCount

      public final Integer maxSuggestionsCount()

      The maximum number of query suggestions you want to show to your users.

      Returns:
      The maximum number of query suggestions you want to show to your users.

    • suggestionTypes

      public final List<SuggestionType> suggestionTypes()

      The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

      If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

      If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

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

      Returns:
      The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

      If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

      If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

    • hasSuggestionTypes

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

    • suggestionTypesAsStrings

      public final List<String> suggestionTypesAsStrings()

      The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

      If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

      If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

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

      Returns:
      The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

      If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

      If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

    • attributeSuggestionsConfig

      public final AttributeSuggestionsGetConfig attributeSuggestionsConfig()

      Configuration information for the document fields/attributes that you want to base query suggestions on.

      Returns:
      Configuration information for the document fields/attributes that you want to base query suggestions on.

    • toBuilder

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

    • builder

      public static GetQuerySuggestionsRequest.Builder builder()

    • serializableBuilderClass

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