Class CIDRSummary

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

Summarizes the CIDR blocks used by the IP set references in a firewall. Network Firewall calculates the number of CIDRs by taking an aggregated count of all CIDRs used by the IP sets you are referencing.

See Also:

  • Method Details

    • availableCIDRCount

      public final Integer availableCIDRCount()

      The number of CIDR blocks available for use by the IP set references in a firewall.

      Returns:
      The number of CIDR blocks available for use by the IP set references in a firewall.

    • utilizedCIDRCount

      public final Integer utilizedCIDRCount()

      The number of CIDR blocks used by the IP set references in a firewall.

      Returns:
      The number of CIDR blocks used by the IP set references in a firewall.

    • hasIpSetReferences

      public final boolean hasIpSetReferences()
      For responses, this returns true if the service returned a value for the IPSetReferences 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.

    • ipSetReferences

      public final Map<String,IPSetMetadata> ipSetReferences()

      The list of the IP set references used by a firewall.

      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 hasIpSetReferences() method.

      Returns:
      The list of the IP set references used by a firewall.

    • toBuilder

      public CIDRSummary.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<CIDRSummary.Builder,CIDRSummary>
      Returns:
      a builder for type T

    • builder

      public static CIDRSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CIDRSummary.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.