/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RuleGroup implements Serializable, Cloneable, StructuredPojo { /** *

* The name of the rule group. You cannot change the name of a rule group after you create it. *

*/ private String name; /** *

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

*/ private String id; /** *

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

*/ private Long capacity; /** *

* The Amazon Resource Name (ARN) of the entity. *

*/ private String aRN; /** *

* A description of the rule group that helps with identification. *

*/ private String description; /** *

* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule * includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how * WAF handles them. *

*/ private java.util.List rules; /** *

* Defines and enables Amazon CloudWatch metrics and web request sample collection. *

*/ private VisibilityConfig visibilityConfig; /** *

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

* */ private String labelNamespace; /** *

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

*/ private java.util.Map customResponseBodies; /** *

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

*/ private java.util.List availableLabels; /** *

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

*/ private java.util.List consumedLabels; /** *

* The name of the rule group. You cannot change the name of a rule group after you create it. *

* * @param name * The name of the rule group. You cannot change the name of a rule group after you create it. */ public void setName(String name) { this.name = name; } /** *

* The name of the rule group. You cannot change the name of a rule group after you create it. *

* * @return The name of the rule group. You cannot change the name of a rule group after you create it. */ public String getName() { return this.name; } /** *

* The name of the rule group. You cannot change the name of a rule group after you create it. *

* * @param name * The name of the rule group. You cannot change the name of a rule group after you create it. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withName(String name) { setName(name); return this; } /** *

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

* * @param 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. */ public void setId(String id) { this.id = 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. *

* * @return 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. */ public String getId() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withId(String id) { setId(id); return this; } /** *

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

* * @param 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. */ public void setCapacity(Long capacity) { this.capacity = 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. *

* * @return 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. */ public Long getCapacity() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withCapacity(Long capacity) { setCapacity(capacity); return this; } /** *

* The Amazon Resource Name (ARN) of the entity. *

* * @param aRN * The Amazon Resource Name (ARN) of the entity. */ public void setARN(String aRN) { this.aRN = aRN; } /** *

* The Amazon Resource Name (ARN) of the entity. *

* * @return The Amazon Resource Name (ARN) of the entity. */ public String getARN() { return this.aRN; } /** *

* The Amazon Resource Name (ARN) of the entity. *

* * @param aRN * The Amazon Resource Name (ARN) of the entity. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withARN(String aRN) { setARN(aRN); return this; } /** *

* A description of the rule group that helps with identification. *

* * @param description * A description of the rule group that helps with identification. */ public void setDescription(String description) { this.description = description; } /** *

* A description of the rule group that helps with identification. *

* * @return A description of the rule group that helps with identification. */ public String getDescription() { return this.description; } /** *

* A description of the rule group that helps with identification. *

* * @param description * A description of the rule group that helps with identification. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withDescription(String description) { setDescription(description); return this; } /** *

* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule * includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how * WAF handles them. *

* * @return The Rule statements used to identify the web requests that you want to allow, block, or count. * Each rule includes one top-level statement that WAF uses to identify matching web requests, and * parameters that govern how WAF handles them. */ public java.util.List getRules() { return rules; } /** *

* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule * includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how * WAF handles them. *

* * @param rules * The Rule statements used to identify the web requests that you want to allow, block, or count. Each * rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that * govern how WAF handles them. */ public void setRules(java.util.Collection rules) { if (rules == null) { this.rules = null; return; } this.rules = new java.util.ArrayList(rules); } /** *

* The Rule statements used to identify the web requests that you want to allow, block, or count. 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 * {@link #setRules(java.util.Collection)} or {@link #withRules(java.util.Collection)} if you want to override the * existing values. *

* * @param rules * The Rule statements used to identify the web requests that you want to allow, block, or count. Each * rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that * govern how WAF handles them. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withRules(Rule... rules) { if (this.rules == null) { setRules(new java.util.ArrayList(rules.length)); } for (Rule ele : rules) { this.rules.add(ele); } return this; } /** *

* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule * includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how * WAF handles them. *

* * @param rules * The Rule statements used to identify the web requests that you want to allow, block, or count. Each * rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that * govern how WAF handles them. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withRules(java.util.Collection rules) { setRules(rules); return this; } /** *

* Defines and enables Amazon CloudWatch metrics and web request sample collection. *

* * @param visibilityConfig * Defines and enables Amazon CloudWatch metrics and web request sample collection. */ public void setVisibilityConfig(VisibilityConfig visibilityConfig) { this.visibilityConfig = visibilityConfig; } /** *

* Defines and enables Amazon CloudWatch metrics and web request sample collection. *

* * @return Defines and enables Amazon CloudWatch metrics and web request sample collection. */ public VisibilityConfig getVisibilityConfig() { return this.visibilityConfig; } /** *

* Defines and enables Amazon CloudWatch metrics and web request sample collection. *

* * @param visibilityConfig * Defines and enables Amazon CloudWatch metrics and web request sample collection. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withVisibilityConfig(VisibilityConfig visibilityConfig) { setVisibilityConfig(visibilityConfig); return this; } /** *

* 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> *

    *
    • *
* * @param 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> *

    *
    • */ public void setLabelNamespace(String labelNamespace) { this.labelNamespace = 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> *

      *
      • *
    * * @return 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> *

      *
      • */ public String getLabelNamespace() { return this.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> *

        *
        • *
      * * @param 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> *

        *
        • * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withLabelNamespace(String labelNamespace) { setLabelNamespace(labelNamespace); return this; } /** *

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

        * * @return 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. */ public java.util.Map getCustomResponseBodies() { return 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. *

        * * @param 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. */ public void setCustomResponseBodies(java.util.Map customResponseBodies) { this.customResponseBodies = 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. *

        * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withCustomResponseBodies(java.util.Map customResponseBodies) { setCustomResponseBodies(customResponseBodies); return this; } /** * Add a single CustomResponseBodies entry * * @see RuleGroup#withCustomResponseBodies * @returns a reference to this object so that method calls can be chained together. */ public RuleGroup addCustomResponseBodiesEntry(String key, CustomResponseBody value) { if (null == this.customResponseBodies) { this.customResponseBodies = new java.util.HashMap(); } if (this.customResponseBodies.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.customResponseBodies.put(key, value); return this; } /** * Removes all the entries added into CustomResponseBodies. * * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup clearCustomResponseBodiesEntries() { this.customResponseBodies = null; return this; } /** *

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

        * * @return 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. */ public java.util.List getAvailableLabels() { return 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. *

        * * @param 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. */ public void setAvailableLabels(java.util.Collection availableLabels) { if (availableLabels == null) { this.availableLabels = null; return; } this.availableLabels = new java.util.ArrayList(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 * {@link #setAvailableLabels(java.util.Collection)} or {@link #withAvailableLabels(java.util.Collection)} if you * want to override the existing values. *

        * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withAvailableLabels(LabelSummary... availableLabels) { if (this.availableLabels == null) { setAvailableLabels(new java.util.ArrayList(availableLabels.length)); } for (LabelSummary ele : availableLabels) { this.availableLabels.add(ele); } return this; } /** *

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

        * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withAvailableLabels(java.util.Collection availableLabels) { setAvailableLabels(availableLabels); return this; } /** *

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

        * * @return 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. */ public java.util.List getConsumedLabels() { return 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. *

        * * @param 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. */ public void setConsumedLabels(java.util.Collection consumedLabels) { if (consumedLabels == null) { this.consumedLabels = null; return; } this.consumedLabels = new java.util.ArrayList(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 * {@link #setConsumedLabels(java.util.Collection)} or {@link #withConsumedLabels(java.util.Collection)} if you want * to override the existing values. *

        * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withConsumedLabels(LabelSummary... consumedLabels) { if (this.consumedLabels == null) { setConsumedLabels(new java.util.ArrayList(consumedLabels.length)); } for (LabelSummary ele : consumedLabels) { this.consumedLabels.add(ele); } return this; } /** *

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

        * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RuleGroup withConsumedLabels(java.util.Collection consumedLabels) { setConsumedLabels(consumedLabels); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getId() != null) sb.append("Id: ").append(getId()).append(","); if (getCapacity() != null) sb.append("Capacity: ").append(getCapacity()).append(","); if (getARN() != null) sb.append("ARN: ").append(getARN()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getRules() != null) sb.append("Rules: ").append(getRules()).append(","); if (getVisibilityConfig() != null) sb.append("VisibilityConfig: ").append(getVisibilityConfig()).append(","); if (getLabelNamespace() != null) sb.append("LabelNamespace: ").append(getLabelNamespace()).append(","); if (getCustomResponseBodies() != null) sb.append("CustomResponseBodies: ").append(getCustomResponseBodies()).append(","); if (getAvailableLabels() != null) sb.append("AvailableLabels: ").append(getAvailableLabels()).append(","); if (getConsumedLabels() != null) sb.append("ConsumedLabels: ").append(getConsumedLabels()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof RuleGroup == false) return false; RuleGroup other = (RuleGroup) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getId() == null ^ this.getId() == null) return false; if (other.getId() != null && other.getId().equals(this.getId()) == false) return false; if (other.getCapacity() == null ^ this.getCapacity() == null) return false; if (other.getCapacity() != null && other.getCapacity().equals(this.getCapacity()) == false) return false; if (other.getARN() == null ^ this.getARN() == null) return false; if (other.getARN() != null && other.getARN().equals(this.getARN()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getRules() == null ^ this.getRules() == null) return false; if (other.getRules() != null && other.getRules().equals(this.getRules()) == false) return false; if (other.getVisibilityConfig() == null ^ this.getVisibilityConfig() == null) return false; if (other.getVisibilityConfig() != null && other.getVisibilityConfig().equals(this.getVisibilityConfig()) == false) return false; if (other.getLabelNamespace() == null ^ this.getLabelNamespace() == null) return false; if (other.getLabelNamespace() != null && other.getLabelNamespace().equals(this.getLabelNamespace()) == false) return false; if (other.getCustomResponseBodies() == null ^ this.getCustomResponseBodies() == null) return false; if (other.getCustomResponseBodies() != null && other.getCustomResponseBodies().equals(this.getCustomResponseBodies()) == false) return false; if (other.getAvailableLabels() == null ^ this.getAvailableLabels() == null) return false; if (other.getAvailableLabels() != null && other.getAvailableLabels().equals(this.getAvailableLabels()) == false) return false; if (other.getConsumedLabels() == null ^ this.getConsumedLabels() == null) return false; if (other.getConsumedLabels() != null && other.getConsumedLabels().equals(this.getConsumedLabels()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode()); hashCode = prime * hashCode + ((getCapacity() == null) ? 0 : getCapacity().hashCode()); hashCode = prime * hashCode + ((getARN() == null) ? 0 : getARN().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getRules() == null) ? 0 : getRules().hashCode()); hashCode = prime * hashCode + ((getVisibilityConfig() == null) ? 0 : getVisibilityConfig().hashCode()); hashCode = prime * hashCode + ((getLabelNamespace() == null) ? 0 : getLabelNamespace().hashCode()); hashCode = prime * hashCode + ((getCustomResponseBodies() == null) ? 0 : getCustomResponseBodies().hashCode()); hashCode = prime * hashCode + ((getAvailableLabels() == null) ? 0 : getAvailableLabels().hashCode()); hashCode = prime * hashCode + ((getConsumedLabels() == null) ? 0 : getConsumedLabels().hashCode()); return hashCode; } @Override public RuleGroup clone() { try { return (RuleGroup) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.wafv2.model.transform.RuleGroupMarshaller.getInstance().marshall(this, protocolMarshaller); } }