com.amazonaws.services.waf.model

Class RuleSummary

java.lang.Object

com.amazonaws.services.waf.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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the 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)
String	getName() A friendly name or description of the Rule.
String	getRuleId() A unique identifier for a Rule.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setName(String name) A friendly name or description of the Rule.
void	setRuleId(String ruleId) A unique identifier for a Rule.
String	toString() Returns a string representation of this object.
RuleSummary	withName(String name) A friendly name or description of the Rule.
RuleSummary	withRuleId(String ruleId) A unique identifier for a Rule.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleSummary

public RuleSummary()

Method Detail

setRuleId

public void setRuleId(String ruleId)

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Parameters:

ruleId - A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

getRuleId

public String getRuleId()

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Returns:

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

withRuleId

public RuleSummary withRuleId(String ruleId)

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Parameters:

ruleId - A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Returns:

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

setName

public void setName(String name)

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

Parameters:

name - A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

getName

public String getName()

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

Returns:

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

withName

public RuleSummary withName(String name)

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

Parameters:

name - A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

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.