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

Class Rule

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.Rule

All Implemented Interfaces:

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

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

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Rule.Builder

Method Summary

Modifier and Type	Method	Description
static Rule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
UsersAndGroups	excludedUsersAndGroups()	Users and groups to be excluded from a rule.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
UsersAndGroups	includedUsersAndGroups()	Users and groups to be included in a rule.
RuleConfiguration	ruleConfiguration()	The configuration information for a rule.
RuleType	ruleType()	The type of rule.
String	ruleTypeAsString()	The type of rule.
List<SdkField<?>>	sdkFields()
static Class<? extends Rule.Builder>	serializableBuilderClass()
Rule.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

includedUsersAndGroups

public final UsersAndGroups includedUsersAndGroups()

Users and groups to be included in a rule.

Returns:

Users and groups to be included in a rule.

excludedUsersAndGroups

public final UsersAndGroups excludedUsersAndGroups()

Users and groups to be excluded from a rule.

Returns:

Users and groups to be excluded from a rule.

ruleType

public final RuleType ruleType()

The type of rule.

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

Returns:

The type of rule.

See Also:

RuleType

ruleTypeAsString

public final String ruleTypeAsString()

The type of rule.

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

Returns:

The type of rule.

See Also:

RuleType

ruleConfiguration

public final RuleConfiguration ruleConfiguration()

The configuration information for a rule.

Returns:

The configuration information for a rule.

toBuilder

public Rule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Rule.Builder,Rule>

builder

public static Rule.Builder builder()

serializableBuilderClass

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