Package software.amazon.awssdk.services.wisdom.model

Class QuickResponseQueryField

java.lang.Object

software.amazon.awssdk.services.wisdom.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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QuickResponseQueryField.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allowFuzziness()	Whether the query expects only exact matches on the attribute field values.
static QuickResponseQueryField.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
String	name()	The name of the attribute to query the quick responses by.
QuickResponseQueryOperator	operator()	The operator to use for matching attribute field values in the query.
String	operatorAsString()	The operator to use for matching attribute field values in the query.
Priority	priority()	The importance of the attribute field when calculating query result relevancy scores.
String	priorityAsString()	The importance of the attribute field when calculating query result relevancy scores.
List<SdkField<?>>	sdkFields()
static Class<? extends QuickResponseQueryField.Builder>	serializableBuilderClass()
QuickResponseQueryField.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The values of the attribute to query the quick responses by.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

QuickResponseQueryOperator

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:

QuickResponseQueryOperator

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:

Priority

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:

Priority

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

Specified by:

toBuilder in interface ToCopyableBuilder<QuickResponseQueryField.Builder,QuickResponseQueryField>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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