Class FirewallPolicyV2Response

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

The high-level properties of a Next Generation policy. This includes the policy's identity, status, consumed capacity, and association count. Network Firewall returns this object in response to the Next Generation policy operations. To retrieve the policy's rule groups and settings, use the FirewallPolicyV2 object.

See Also:

  • Method Details

    • firewallPolicyV2Name

      public final String firewallPolicyV2Name()

      The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.

      Returns:
      The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.

    • firewallPolicyV2Arn

      public final String firewallPolicyV2Arn()

      The Amazon Resource Name (ARN) of the Next Generation policy.

      Returns:
      The Amazon Resource Name (ARN) of the Next Generation policy.

    • firewallPolicyV2Id

      public final String firewallPolicyV2Id()

      The unique identifier of the Next Generation policy. Network Firewall assigns this identifier when you create the policy.

      Returns:
      The unique identifier of the Next Generation policy. Network Firewall assigns this identifier when you create the policy.

    • description

      public final String description()

      A description of the Next Generation policy.

      Returns:
      A description of the Next Generation policy.

    • firewallPolicyV2Status

      public final ResourceStatus firewallPolicyV2Status()

      The current status of the Next Generation policy. A policy must be in the ACTIVE state before you can use it in a firewall.

      If the service returns an enum value that is not available in the current SDK version, firewallPolicyV2Status will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from firewallPolicyV2StatusAsString().

      Returns:
      The current status of the Next Generation policy. A policy must be in the ACTIVE state before you can use it in a firewall.
      See Also:

    • firewallPolicyV2StatusAsString

      public final String firewallPolicyV2StatusAsString()

      The current status of the Next Generation policy. A policy must be in the ACTIVE state before you can use it in a firewall.

      If the service returns an enum value that is not available in the current SDK version, firewallPolicyV2Status will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from firewallPolicyV2StatusAsString().

      Returns:
      The current status of the Next Generation policy. A policy must be in the ACTIVE state before you can use it in a firewall.
      See Also:

    • statusMessage

      public final String statusMessage()

      Additional information about the current status of the Next Generation policy.

      Returns:
      Additional information about the current status of the Next Generation policy.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The key-value tag pairs that are associated with the Next Generation policy.

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

      Returns:
      The key-value tag pairs that are associated with the Next Generation policy.

    • consumedFirewallRuleCapacity

      public final Integer consumedFirewallRuleCapacity()

      The number of firewall engine rule capacity units that the policy's firewall section currently consumes.

      Returns:
      The number of firewall engine rule capacity units that the policy's firewall section currently consumes.

    • consumedIpsRuleCapacity

      public final Integer consumedIpsRuleCapacity()

      The number of IPS engine rule capacity units that the policy's IPS section currently consumes.

      Returns:
      The number of IPS engine rule capacity units that the policy's IPS section currently consumes.

    • consumedIpsDomainCapacity

      public final Integer consumedIpsDomainCapacity()

      The number of IPS domain list capacity units that the policy's IPS section currently consumes.

      Returns:
      The number of IPS domain list capacity units that the policy's IPS section currently consumes.

    • numberOfAssociations

      public final Integer numberOfAssociations()

      The number of firewalls that are associated with the Next Generation policy.

      Returns:
      The number of firewalls that are associated with the Next Generation policy.

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your Next Generation policy.

      Returns:
      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your Next Generation policy.

    • hasErrors

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

    • errors

      public final List<FirewallPolicyError> errors()

      Any configuration errors that apply to the Next Generation policy. Network Firewall detects these errors asynchronously, after you create or update the policy, so an error can appear after the request that caused it has already succeeded. Each entry describes the problem and how to resolve it, and Network Firewall clears it automatically after you resolve the problem.

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

      Returns:
      Any configuration errors that apply to the Next Generation policy. Network Firewall detects these errors asynchronously, after you create or update the policy, so an error can appear after the request that caused it has already succeeded. Each entry describes the problem and how to resolve it, and Network Firewall clears it automatically after you resolve the problem.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last time that the Next Generation policy was changed.

      Returns:
      The last time that the Next Generation policy was changed.

    • toBuilder

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

    • builder

      public static FirewallPolicyV2Response.Builder builder()

    • serializableBuilderClass

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