Class Search

java.lang.Object
software.amazon.awssdk.services.kendra.model.Search
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Search.Builder,Search>
@Generated("software.amazon.awssdk:codegen") public final class Search extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Search.Builder,Search>

Provides information about how a custom index field is used during a search.

See Also:

  • Method Details

    • facetable

      public final Boolean facetable()

      Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

      Returns:
      Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

    • searchable

      public final Boolean searchable()

      Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

      Returns:
      Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

    • displayable

      public final Boolean displayable()

      Determines whether the field is returned in the query response. The default is true.

      Returns:
      Determines whether the field is returned in the query response. The default is true.

    • sortable

      public final Boolean sortable()

      Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

      Returns:
      Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

    • toBuilder

      public Search.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<Search.Builder,Search>
      Returns:
      a builder for type T

    • builder

      public static Search.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.