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

Class RuleConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.RuleConfiguration

All Implemented Interfaces:

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

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

Provides configuration information about a rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleConfiguration.Builder
static class	RuleConfiguration.Type

Method Summary

Modifier and Type	Method	Description
static RuleConfiguration.Builder	builder()
ContentBlockerRule	contentBlockerRule()	A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
ContentRetrievalRule	contentRetrievalRule()	Returns the value of the ContentRetrievalRule property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static RuleConfiguration	fromContentBlockerRule(Consumer<ContentBlockerRule.Builder> contentBlockerRule)	Create an instance of this class with contentBlockerRule() initialized to the given value.
static RuleConfiguration	fromContentBlockerRule(ContentBlockerRule contentBlockerRule)	Create an instance of this class with contentBlockerRule() initialized to the given value.
static RuleConfiguration	fromContentRetrievalRule(Consumer<ContentRetrievalRule.Builder> contentRetrievalRule)	Create an instance of this class with contentRetrievalRule() initialized to the given value.
static RuleConfiguration	fromContentRetrievalRule(ContentRetrievalRule contentRetrievalRule)	Create an instance of this class with contentRetrievalRule() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends RuleConfiguration.Builder>	serializableBuilderClass()
RuleConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RuleConfiguration.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

contentBlockerRule

public final ContentBlockerRule contentBlockerRule()

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

Returns:

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

contentRetrievalRule

public final ContentRetrievalRule contentRetrievalRule()

Returns the value of the ContentRetrievalRule property for this object.

Returns:

The value of the ContentRetrievalRule property for this object.

toBuilder

public RuleConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleConfiguration.Builder,RuleConfiguration>

builder

public static RuleConfiguration.Builder builder()

serializableBuilderClass

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

fromContentBlockerRule

public static RuleConfiguration fromContentBlockerRule(ContentBlockerRule contentBlockerRule)

Create an instance of this class with contentBlockerRule() initialized to the given value.

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

Parameters:

contentBlockerRule - A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

fromContentBlockerRule

public static RuleConfiguration fromContentBlockerRule(Consumer<ContentBlockerRule.Builder> contentBlockerRule)

Create an instance of this class with contentBlockerRule() initialized to the given value.

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

Parameters:

contentBlockerRule - A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

fromContentRetrievalRule

public static RuleConfiguration fromContentRetrievalRule(ContentRetrievalRule contentRetrievalRule)

Create an instance of this class with contentRetrievalRule() initialized to the given value. Sets the value of the ContentRetrievalRule property for this object.

Parameters:

contentRetrievalRule - The new value for the ContentRetrievalRule property for this object.

fromContentRetrievalRule

public static RuleConfiguration fromContentRetrievalRule(Consumer<ContentRetrievalRule.Builder> contentRetrievalRule)

Create an instance of this class with contentRetrievalRule() initialized to the given value. Sets the value of the ContentRetrievalRule property for this object.

Parameters:

contentRetrievalRule - The new value for the ContentRetrievalRule property for this object.

type

public RuleConfiguration.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RuleConfiguration.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RuleConfiguration.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo