com.amazonaws.services.qbusiness.model

Class Rule

java.lang.Object

com.amazonaws.services.qbusiness.model.Rule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Rule
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Rule()

Method Summary

Modifier and Type	Method and Description
Rule	clone()
boolean	equals(Object obj)
UsersAndGroups	getExcludedUsersAndGroups() Users and groups to be excluded from a rule.
UsersAndGroups	getIncludedUsersAndGroups() Users and groups to be included in a rule.
RuleConfiguration	getRuleConfiguration() The configuration information for a rule.
String	getRuleType() The type of rule.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setExcludedUsersAndGroups(UsersAndGroups excludedUsersAndGroups) Users and groups to be excluded from a rule.
void	setIncludedUsersAndGroups(UsersAndGroups includedUsersAndGroups) Users and groups to be included in a rule.
void	setRuleConfiguration(RuleConfiguration ruleConfiguration) The configuration information for a rule.
void	setRuleType(String ruleType) The type of rule.
String	toString() Returns a string representation of this object.
Rule	withExcludedUsersAndGroups(UsersAndGroups excludedUsersAndGroups) Users and groups to be excluded from a rule.
Rule	withIncludedUsersAndGroups(UsersAndGroups includedUsersAndGroups) Users and groups to be included in a rule.
Rule	withRuleConfiguration(RuleConfiguration ruleConfiguration) The configuration information for a rule.
Rule	withRuleType(RuleType ruleType) The type of rule.
Rule	withRuleType(String ruleType) The type of rule.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rule

public Rule()

Method Detail

setIncludedUsersAndGroups

public void setIncludedUsersAndGroups(UsersAndGroups includedUsersAndGroups)

Users and groups to be included in a rule.

Parameters:

includedUsersAndGroups - Users and groups to be included in a rule.

getIncludedUsersAndGroups

public UsersAndGroups getIncludedUsersAndGroups()

Users and groups to be included in a rule.

Returns:

Users and groups to be included in a rule.

withIncludedUsersAndGroups

public Rule withIncludedUsersAndGroups(UsersAndGroups includedUsersAndGroups)

Users and groups to be included in a rule.

Parameters:

includedUsersAndGroups - Users and groups to be included in a rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExcludedUsersAndGroups

public void setExcludedUsersAndGroups(UsersAndGroups excludedUsersAndGroups)

Users and groups to be excluded from a rule.

Parameters:

excludedUsersAndGroups - Users and groups to be excluded from a rule.

getExcludedUsersAndGroups

public UsersAndGroups getExcludedUsersAndGroups()

Users and groups to be excluded from a rule.

Returns:

Users and groups to be excluded from a rule.

withExcludedUsersAndGroups

public Rule withExcludedUsersAndGroups(UsersAndGroups excludedUsersAndGroups)

Users and groups to be excluded from a rule.

Parameters:

excludedUsersAndGroups - Users and groups to be excluded from a rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRuleType

public void setRuleType(String ruleType)

The type of rule.

Parameters:

ruleType - The type of rule.

See Also:

RuleType

getRuleType

public String getRuleType()

The type of rule.

Returns:

The type of rule.

See Also:

RuleType

withRuleType

public Rule withRuleType(String ruleType)

The type of rule.

Parameters:

ruleType - The type of rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleType

withRuleType

public Rule withRuleType(RuleType ruleType)

The type of rule.

Parameters:

ruleType - The type of rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleType

setRuleConfiguration

public void setRuleConfiguration(RuleConfiguration ruleConfiguration)

The configuration information for a rule.

Parameters:

ruleConfiguration - The configuration information for a rule.

getRuleConfiguration

public RuleConfiguration getRuleConfiguration()

The configuration information for a rule.

Returns:

The configuration information for a rule.

withRuleConfiguration

public Rule withRuleConfiguration(RuleConfiguration ruleConfiguration)

The configuration information for a rule.

Parameters:

ruleConfiguration - The configuration information for a rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Rule clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.