Package software.amazon.awssdk.services.networkfirewall.model

Class FirewallPolicyResponse

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

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

See Also:

  • Method Details

    • firewallPolicyName

      public final String firewallPolicyName()

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

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

    • firewallPolicyArn

      public final String firewallPolicyArn()

      The Amazon Resource Name (ARN) of the firewall policy.

      If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

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

      If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

    • firewallPolicyId

      public final String firewallPolicyId()

      The unique identifier for the firewall policy.

      Returns:
      The unique identifier for the firewall policy.

    • description

      public final String description()

      A description of the firewall policy.

      Returns:
      A description of the firewall policy.

    • firewallPolicyStatus

      public final ResourceStatus firewallPolicyStatus()

      The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

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

      Returns:
      The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
      See Also:

    • firewallPolicyStatusAsString

      public final String firewallPolicyStatusAsString()

      The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

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

      Returns:
      The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
      See Also:

    • 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 pairs to associate with the resource.

      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 pairs to associate with the resource.

    • consumedStatelessRuleCapacity

      public final Integer consumedStatelessRuleCapacity()

      The number of capacity units currently consumed by the policy's stateless rules.

      Returns:
      The number of capacity units currently consumed by the policy's stateless rules.

    • consumedStatefulRuleCapacity

      public final Integer consumedStatefulRuleCapacity()

      The number of capacity units currently consumed by the policy's stateful rules.

      Returns:
      The number of capacity units currently consumed by the policy's stateful rules.

    • numberOfAssociations

      public final Integer numberOfAssociations()

      The number of firewalls that are associated with this firewall policy.

      Returns:
      The number of firewalls that are associated with this firewall policy.

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

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

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

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last time that the firewall policy was changed.

      Returns:
      The last time that the firewall policy was changed.

    • toBuilder

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

    • builder

      public static FirewallPolicyResponse.Builder builder()

    • serializableBuilderClass

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