Package software.amazon.awssdk.services.qconnect.model

Class QuickResponseQueryField

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

The quick response fields to query quick responses by.

The following is the list of supported field names.

  • content

  • name

  • description

  • shortcutKey

See Also:

  • Method Details

    • allowFuzziness

      public final Boolean allowFuzziness()

      Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

      Returns:
      Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

    • name

      public final String name()

      The name of the attribute to query the quick responses by.

      Returns:
      The name of the attribute to query the quick responses by.

    • operator

      public final QuickResponseQueryOperator operator()

      The operator to use for matching attribute field values in the query.

      If the service returns an enum value that is not available in the current SDK version, operator will return QuickResponseQueryOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

      Returns:
      The operator to use for matching attribute field values in the query.
      See Also:

    • operatorAsString

      public final String operatorAsString()

      The operator to use for matching attribute field values in the query.

      If the service returns an enum value that is not available in the current SDK version, operator will return QuickResponseQueryOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

      Returns:
      The operator to use for matching attribute field values in the query.
      See Also:

    • priority

      public final Priority priority()

      The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.

      If the service returns an enum value that is not available in the current SDK version, priority will return Priority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priorityAsString().

      Returns:
      The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
      See Also:

    • priorityAsString

      public final String priorityAsString()

      The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.

      If the service returns an enum value that is not available in the current SDK version, priority will return Priority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priorityAsString().

      Returns:
      The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
      See Also:

    • hasValues

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

    • values

      public final List<String> values()

      The values of the attribute to query the quick responses by.

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

      Returns:
      The values of the attribute to query the quick responses by.

    • toBuilder

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

    • builder

      public static QuickResponseQueryField.Builder builder()

    • serializableBuilderClass

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