Class AwsWafv2RuleGroupDetails

java.lang.Object
software.amazon.awssdk.services.securityhub.model.AwsWafv2RuleGroupDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AwsWafv2RuleGroupDetails.Builder,AwsWafv2RuleGroupDetails>
@Generated("software.amazon.awssdk:codegen") public final class AwsWafv2RuleGroupDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsWafv2RuleGroupDetails.Builder,AwsWafv2RuleGroupDetails>

Details about an WAFv2 rule group.

See Also:

  • Method Details

    • capacity

      public final Long capacity()

      The web ACL capacity units (WCUs) required for this rule group.

      Returns:
      The web ACL capacity units (WCUs) required for this rule group.

    • description

      public final String description()

      A description of the rule group that helps with identification.

      Returns:
      A description of the rule group that helps with identification.

    • id

      public final String id()

      A unique identifier for the rule group.

      Returns:
      A unique identifier for the rule group.

    • name

      public final String name()

      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.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the entity.

      Returns:
      The Amazon Resource Name (ARN) of the entity.

    • hasRules

      public final boolean hasRules()
      For responses, this returns true if the service returned a value for the Rules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • rules

      public final List<AwsWafv2RulesDetails> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRules() method.

      Returns:
      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.

    • scope

      public final String scope()

      Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

      Returns:
      Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

    • visibilityConfig

      public final AwsWafv2VisibilityConfigDetails visibilityConfig()

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

      Returns:
      Defines and enables Amazon CloudWatch metrics and web request sample collection.

    • toBuilder

      public AwsWafv2RuleGroupDetails.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AwsWafv2RuleGroupDetails.Builder,AwsWafv2RuleGroupDetails>
      Returns:
      a builder for type T

    • builder

      public static AwsWafv2RuleGroupDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsWafv2RuleGroupDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.