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

Class QuickResponseFilterField

java.lang.Object

software.amazon.awssdk.services.qconnect.model.QuickResponseFilterField

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QuickResponseFilterField.Builder,QuickResponseFilterField>

@Generated("software.amazon.awssdk:codegen")
public final class QuickResponseFilterField
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QuickResponseFilterField.Builder,QuickResponseFilterField>

The quick response fields to filter the quick response query results by.

The following is the list of supported field names.

• name

• description

• shortcutKey

• isActive

• channels

• language

• contentType

• createdTime

• lastModifiedTime

• lastModifiedBy

• groupingConfiguration.criteria

• groupingConfiguration.values

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QuickResponseFilterField.Builder

Method Summary

Modifier and Type	Method	Description
static QuickResponseFilterField.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.
Boolean	includeNoExistence()	Whether to treat null value as a match for the attribute field.
String	name()	The name of the attribute field to filter the quick responses by.
QuickResponseFilterOperator	operator()	The operator to use for filtering.
String	operatorAsString()	The operator to use for filtering.
List<SdkField<?>>	sdkFields()
static Class<? extends QuickResponseFilterField.Builder>	serializableBuilderClass()
QuickResponseFilterField.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The values of attribute field to filter the quick response 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

includeNoExistence

public final Boolean includeNoExistence()

Whether to treat null value as a match for the attribute field.

Returns:

Whether to treat null value as a match for the attribute field.

name

public final String name()

The name of the attribute field to filter the quick responses by.

Returns:

The name of the attribute field to filter the quick responses by.

operator

public final QuickResponseFilterOperator operator()

The operator to use for filtering.

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

Returns:

The operator to use for filtering.

See Also:

QuickResponseFilterOperator

operatorAsString

public final String operatorAsString()

The operator to use for filtering.

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

Returns:

The operator to use for filtering.

See Also:

QuickResponseFilterOperator

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 attribute field to filter the quick response 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 attribute field to filter the quick response by.

toBuilder

public QuickResponseFilterField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QuickResponseFilterField.Builder,QuickResponseFilterField>

builder

public static QuickResponseFilterField.Builder builder()

serializableBuilderClass

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