RuleGroup (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.wafv2.model

Class RuleGroup

java.lang.Object
- com.amazonaws.services.wafv2.model.RuleGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroup
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleGroup ()

Constructors
Constructor and Description
`RuleGroup ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`RuleGroup`	`addCustomResponseBodiesEntry (String key, CustomResponseBody value)` Add a single CustomResponseBodies entry
`RuleGroup`	`clearCustomResponseBodiesEntries ()` Removes all the entries added into CustomResponseBodies.
`RuleGroup`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getARN ()` The Amazon Resource Name (ARN) of the entity.
`List<LabelSummary>`	`getAvailableLabels ()` The labels that one or more rules in this rule group add to matching web requests.
`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.
`Map<String,CustomResponseBody>`	`getCustomResponseBodies ()` A map of custom response keys and content bodies.
`String`	`getDescription ()` A description of the rule group that helps with identification.
`String`	`getId ()` A unique identifier for the rule group.
`String`	`getLabelNamespace ()` The label namespace prefix for this rule group.
`String`	`getName ()` The name of the rule group.
`List<Rule>`	`getRules ()` The Rule statements used to identify the web requests that you want to manage.
`VisibilityConfig`	`getVisibilityConfig ()` Defines and enables Amazon CloudWatch metrics and web request sample collection.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setARN (String aRN)` The Amazon Resource Name (ARN) of the entity.
`void`	`setAvailableLabels (Collection<LabelSummary> availableLabels)` The labels that one or more rules in this rule group add to matching web requests.
`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`	`setCustomResponseBodies (Map<String,CustomResponseBody> customResponseBodies)` A map of custom response keys and content bodies.
`void`	`setDescription (String description)` A description of the rule group that helps with identification.
`void`	`setId (String id)` A unique identifier for the rule group.
`void`	`setLabelNamespace (String labelNamespace)` The label namespace prefix for this rule group.
`void`	`setName (String name)` The name of the rule group.
`void`	`setRules (Collection<Rule> rules)` The Rule statements used to identify the web requests that you want to manage.
`void`	`setVisibilityConfig (VisibilityConfig visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.
`String`	`toString ()` Returns a string representation of this object.
`RuleGroup`	`withARN (String aRN)` The Amazon Resource Name (ARN) of the entity.
`RuleGroup`	`withAvailableLabels (Collection<LabelSummary> availableLabels)` The labels that one or more rules in this rule group add to matching web requests.
`RuleGroup`	`withAvailableLabels (LabelSummary... availableLabels)` The labels that one or more rules in this rule group add to matching web requests.
`RuleGroup`	`withCapacity (Long capacity)` The web ACL capacity units (WCUs) required for this rule group.
`RuleGroup`	`withConsumedLabels (Collection<LabelSummary> consumedLabels)` The labels that one or more rules in this rule group match against in label match statements.
`RuleGroup`	`withConsumedLabels (LabelSummary... consumedLabels)` The labels that one or more rules in this rule group match against in label match statements.
`RuleGroup`	`withCustomResponseBodies (Map<String,CustomResponseBody> customResponseBodies)` A map of custom response keys and content bodies.
`RuleGroup`	`withDescription (String description)` A description of the rule group that helps with identification.
`RuleGroup`	`withId (String id)` A unique identifier for the rule group.
`RuleGroup`	`withLabelNamespace (String labelNamespace)` The label namespace prefix for this rule group.
`RuleGroup`	`withName (String name)` The name of the rule group.
`RuleGroup`	`withRules (Collection<Rule> rules)` The Rule statements used to identify the web requests that you want to manage.
`RuleGroup`	`withRules (Rule... rules)` The Rule statements used to identify the web requests that you want to manage.
`RuleGroup`	`withVisibilityConfig (VisibilityConfig visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RuleGroup
```
public RuleGroup()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule group. You cannot change the name of a rule group after you create it.
    
    Parameters:
    
    name - The name of the rule group. You cannot change the name of a rule group after you create it.
  - getName
```
public String getName()
```
    The name of the rule group. You cannot change the name of a rule group after you create it.
    
    Returns:
    
    The name of the rule group. You cannot change the name of a rule group after you create it.
  - withName
```
public RuleGroup withName(String name)
```
    The name of the rule group. You cannot change the name of a rule group after you create it.
    
    Parameters:
    
    name - The name of the rule group. You cannot change the name of a rule group after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - getId
```
public String getId()
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - withId
```
public RuleGroup withId(String id)
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCapacity
```
public void setCapacity(Long capacity)
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
    
    Parameters:
    
    capacity - The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
  - getCapacity
```
public Long getCapacity()
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
    
    Returns:
    
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
  - withCapacity
```
public RuleGroup withCapacity(Long capacity)
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
    
    Parameters:
    
    capacity - The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withARN
```
public RuleGroup withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the rule group that helps with identification.
    
    Parameters:
    
    description - A description of the rule group that helps with identification.
  - getDescription
```
public String getDescription()
```
    A description of the rule group that helps with identification.
    
    Returns:
    
    A description of the rule group that helps with identification.
  - withDescription
```
public RuleGroup withDescription(String description)
```
    A description of the rule group that helps with identification.
    
    Parameters:
    
    description - A description of the rule group that helps with identification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRules
```
public List<Rule> getRules()
```
    The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    Returns:
    
    The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
  - setRules
```
public void setRules(Collection<Rule> rules)
```
    The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    Parameters:
    
    rules - The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
  - withRules
```
public RuleGroup withRules(Rule... rules)
```
    The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    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 - The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRules
```
public RuleGroup withRules(Collection<Rule> rules)
```
    The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    Parameters:
    
    rules - The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisibilityConfig
```
public void setVisibilityConfig(VisibilityConfig visibilityConfig)
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Parameters:
    
    visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
  - getVisibilityConfig
```
public VisibilityConfig getVisibilityConfig()
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Returns:
    
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
  - withVisibilityConfig
```
public RuleGroup withVisibilityConfig(VisibilityConfig visibilityConfig)
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Parameters:
    
    visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    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 your rule groups is the following:
      
      awswaf:<account ID>:rulegroup:<rule group name>:
    - When a rule with a label matches a web request, 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 your rule groups is the following:
    
    awswaf:<account ID>:rulegroup:<rule group name>:
    
    When a rule with a label matches a web request, 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 your rule groups is the following:
      
      awswaf:<account ID>:rulegroup:<rule group name>:
    - When a rule with a label matches a web request, 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 your rule groups is the following:
    
    awswaf:<account ID>:rulegroup:<rule group name>:
    
    When a rule with a label matches a web request, 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 RuleGroup 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 your rule groups is the following:
      
      awswaf:<account ID>:rulegroup:<rule group name>:
    - When a rule with a label matches a web request, 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 your rule groups is the following:
    
    awswaf:<account ID>:rulegroup:<rule group name>:
    
    When a rule with a label matches a web request, 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.
  - getCustomResponseBodies
```
public Map<String,CustomResponseBody> getCustomResponseBodies()
```
    A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
    
    For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
    
    For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
    
    Returns:
    
    A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
    
    For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
    
    For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
  - setCustomResponseBodies
```
public void setCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies)
```
    A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
    
    For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
    
    For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
    
    Parameters:
    
    customResponseBodies - A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
    
    For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
    
    For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
  - withCustomResponseBodies
```
public RuleGroup withCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies)
```
    A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
    
    For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
    
    For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
    
    Parameters:
    
    customResponseBodies - A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
    
    For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
    
    For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addCustomResponseBodiesEntry
```
public RuleGroup addCustomResponseBodiesEntry(String key,
 CustomResponseBody value)
```
    Add a single CustomResponseBodies entry
    
    See Also:
    
    withCustomResponseBodies(java.util.Map<java.lang.String, com.amazonaws.services.wafv2.model.CustomResponseBody>)
  - clearCustomResponseBodiesEntries
```
public RuleGroup clearCustomResponseBodiesEntries()
```
    Removes all the entries added into CustomResponseBodies.
    
    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 requests. 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 requests. 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 requests. 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 requests. These labels are defined in the RuleLabels for a Rule.
  - withAvailableLabels
```
public RuleGroup withAvailableLabels(LabelSummary... availableLabels)
```
    The labels that one or more rules in this rule group add to matching web requests. 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 requests. 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 RuleGroup withAvailableLabels(Collection<LabelSummary> availableLabels)
```
    The labels that one or more rules in this rule group add to matching web requests. 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 requests. 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 RuleGroup 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 RuleGroup 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 RuleGroup 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class RuleGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleGroup

Method Detail

setName

getName

withName

setId

getId

withId

setCapacity

getCapacity

withCapacity

setARN

getARN

withARN

setDescription

getDescription

withDescription

getRules

setRules

withRules

withRules

setVisibilityConfig

getVisibilityConfig

withVisibilityConfig

setLabelNamespace

getLabelNamespace

withLabelNamespace

getCustomResponseBodies

setCustomResponseBodies

withCustomResponseBodies

addCustomResponseBodiesEntry

clearCustomResponseBodiesEntries

getAvailableLabels

setAvailableLabels

withAvailableLabels

withAvailableLabels

getConsumedLabels

setConsumedLabels

withConsumedLabels

withConsumedLabels

toString

equals

hashCode

clone

marshall