com.amazonaws.services.wafv2.model

Class RuleSummary

java.lang.Object

com.amazonaws.services.wafv2.model.RuleSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleSummary()

Method Summary

Modifier and Type	Method and Description
RuleSummary	clone()
boolean	equals(Object obj)
RuleAction	getAction() The action that WAF should take on a web request when it matches a rule's statement.
String	getName() The name of the rule.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAction(RuleAction action) The action that WAF should take on a web request when it matches a rule's statement.
void	setName(String name) The name of the rule.
String	toString() Returns a string representation of this object.
RuleSummary	withAction(RuleAction action) The action that WAF should take on a web request when it matches a rule's statement.
RuleSummary	withName(String name) The name of the rule.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleSummary

public RuleSummary()

Method Detail

setName

public void setName(String name)

The name of the rule.

Parameters:

name - The name of the rule.

getName

public String getName()

The name of the rule.

Returns:

The name of the rule.

withName

public RuleSummary withName(String name)

The name of the rule.

Parameters:

name - The name of the rule.

Returns:

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

setAction

public void setAction(RuleAction action)

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

Parameters:

action - The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

getAction

public RuleAction getAction()

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

Returns:

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

withAction

public RuleSummary withAction(RuleAction action)

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

Parameters:

action - The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

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 RuleSummary 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.