com.amazonaws.services.wafv2.model

Class DescribeManagedRuleGroupResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.wafv2.model.DescribeManagedRuleGroupResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeManagedRuleGroupResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeManagedRuleGroupResult()

Method Summary

Modifier and Type	Method and Description
DescribeManagedRuleGroupResult	clone()
boolean	equals(Object obj)
List<LabelSummary>	getAvailableLabels() The labels that one or more rules in this rule group add to matching web ACLs.
Long	getCapacity() The web ACL capacity units (WCUs) required for this rule group.
List<LabelSummary>	getConsumedLabels() The labels that one or more rules in this rule group match against in label match statements.
String	getLabelNamespace() The label namespace prefix for this rule group.
List<RuleSummary>	getRules()
int	hashCode()
void	setAvailableLabels(Collection<LabelSummary> availableLabels) The labels that one or more rules in this rule group add to matching web ACLs.
void	setCapacity(Long capacity) The web ACL capacity units (WCUs) required for this rule group.
void	setConsumedLabels(Collection<LabelSummary> consumedLabels) The labels that one or more rules in this rule group match against in label match statements.
void	setLabelNamespace(String labelNamespace) The label namespace prefix for this rule group.
void	setRules(Collection<RuleSummary> rules)
String	toString() Returns a string representation of this object.
DescribeManagedRuleGroupResult	withAvailableLabels(Collection<LabelSummary> availableLabels) The labels that one or more rules in this rule group add to matching web ACLs.
DescribeManagedRuleGroupResult	withAvailableLabels(LabelSummary... availableLabels) The labels that one or more rules in this rule group add to matching web ACLs.
DescribeManagedRuleGroupResult	withCapacity(Long capacity) The web ACL capacity units (WCUs) required for this rule group.
DescribeManagedRuleGroupResult	withConsumedLabels(Collection<LabelSummary> consumedLabels) The labels that one or more rules in this rule group match against in label match statements.
DescribeManagedRuleGroupResult	withConsumedLabels(LabelSummary... consumedLabels) The labels that one or more rules in this rule group match against in label match statements.
DescribeManagedRuleGroupResult	withLabelNamespace(String labelNamespace) The label namespace prefix for this rule group.
DescribeManagedRuleGroupResult	withRules(Collection<RuleSummary> rules)
DescribeManagedRuleGroupResult	withRules(RuleSummary... rules)

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeManagedRuleGroupResult

public DescribeManagedRuleGroupResult()

Method Detail

setCapacity

public void setCapacity(Long capacity)

The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Parameters:

capacity - The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

getCapacity

public Long getCapacity()

The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Returns:

The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

withCapacity

public DescribeManagedRuleGroupResult withCapacity(Long capacity)

The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Parameters:

capacity - The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Returns:

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

getRules

public List<RuleSummary> getRules()

Returns:

setRules

public void setRules(Collection<RuleSummary> rules)

Parameters:

rules -

withRules

public DescribeManagedRuleGroupResult withRules(RuleSummary... rules)

NOTE: This method appends the values to the existing list (if any). Use setRules(java.util.Collection) or withRules(java.util.Collection) if you want to override the existing values.

Parameters:

rules -

Returns:

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

withRules

public DescribeManagedRuleGroupResult withRules(Collection<RuleSummary> rules)

Parameters:

rules -

Returns:

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

setLabelNamespace

public void setLabelNamespace(String labelNamespace)

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

Parameters:

labelNamespace - The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

getLabelNamespace

public String getLabelNamespace()

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

Returns:

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

withLabelNamespace

public DescribeManagedRuleGroupResult withLabelNamespace(String labelNamespace)

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

Parameters:

labelNamespace - The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed:<vendor>:<rule group name>:

• When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  <label namespace>:<label from rule>

Returns:

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

getAvailableLabels

public List<LabelSummary> getAvailableLabels()

The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

Returns:

The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

setAvailableLabels

public void setAvailableLabels(Collection<LabelSummary> availableLabels)

The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

Parameters:

availableLabels - The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

withAvailableLabels

public DescribeManagedRuleGroupResult withAvailableLabels(LabelSummary... availableLabels)

The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

NOTE: This method appends the values to the existing list (if any). Use setAvailableLabels(java.util.Collection) or withAvailableLabels(java.util.Collection) if you want to override the existing values.

Parameters:

availableLabels - The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

Returns:

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

withAvailableLabels

public DescribeManagedRuleGroupResult withAvailableLabels(Collection<LabelSummary> availableLabels)

The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

Parameters:

availableLabels - The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

Returns:

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

getConsumedLabels

public List<LabelSummary> getConsumedLabels()

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Returns:

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

setConsumedLabels

public void setConsumedLabels(Collection<LabelSummary> consumedLabels)

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Parameters:

consumedLabels - The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

withConsumedLabels

public DescribeManagedRuleGroupResult withConsumedLabels(LabelSummary... consumedLabels)

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

NOTE: This method appends the values to the existing list (if any). Use setConsumedLabels(java.util.Collection) or withConsumedLabels(java.util.Collection) if you want to override the existing values.

Parameters:

consumedLabels - The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Returns:

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

withConsumedLabels

public DescribeManagedRuleGroupResult withConsumedLabels(Collection<LabelSummary> consumedLabels)

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Parameters:

consumedLabels - The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of 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 DescribeManagedRuleGroupResult clone()

Overrides:

clone in class Object