Package software.amazon.awssdk.services.qbusiness.model

Class BlockedPhrasesConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.BlockedPhrasesConfiguration

All Implemented Interfaces:

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

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

Provides information about the phrases blocked from chat by your chat control configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BlockedPhrasesConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	blockedPhrases()	A list of phrases blocked from a Amazon Q Business web experience chat.
static BlockedPhrasesConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlockedPhrases()	For responses, this returns true if the service returned a value for the BlockedPhrases property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends BlockedPhrasesConfiguration.Builder>	serializableBuilderClass()
String	systemMessageOverride()	The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
BlockedPhrasesConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasBlockedPhrases

public final boolean hasBlockedPhrases()

For responses, this returns true if the service returned a value for the BlockedPhrases 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.

blockedPhrases

public final List<String> blockedPhrases()

A list of phrases blocked from a Amazon Q Business web experience chat.

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

Returns:

A list of phrases blocked from a Amazon Q Business web experience chat.

systemMessageOverride

public final String systemMessageOverride()

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

Returns:

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

toBuilder

public BlockedPhrasesConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BlockedPhrasesConfiguration.Builder,BlockedPhrasesConfiguration>

builder

public static BlockedPhrasesConfiguration.Builder builder()

serializableBuilderClass

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