Class DescribeFirewallPolicyV2Request

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest
software.amazon.awssdk.services.networkfirewall.model.DescribeFirewallPolicyV2Request
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeFirewallPolicyV2Request.Builder,DescribeFirewallPolicyV2Request>
@Generated("software.amazon.awssdk:codegen") public final class DescribeFirewallPolicyV2Request extends NetworkFirewallRequest implements ToCopyableBuilder<DescribeFirewallPolicyV2Request.Builder,DescribeFirewallPolicyV2Request>

  • Method Details

    • firewallPolicyV2Arn

      public final String firewallPolicyV2Arn()

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

      You must specify the ARN or the name, and you can specify both.

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

      You must specify the ARN or the name, and you can specify both.

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

      You must specify the ARN or the name, and you can specify both.

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

      You must specify the ARN or the name, and you can specify both.

    • ruleOutputFormat

      public final RuleOutputFormat ruleOutputFormat()

      The format in which to return the rules of any firewall engine rule groups that are embedded in the policy. Specify FIREWALL_RULES for structured FirewallRule objects or RULES_STRING for a Suricata-compatible firewall-mode rule string. If you don't specify a format, Network Firewall returns each embedded rule group in the format you provided it in. Referenced rule groups aren't affected.

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

      Returns:
      The format in which to return the rules of any firewall engine rule groups that are embedded in the policy. Specify FIREWALL_RULES for structured FirewallRule objects or RULES_STRING for a Suricata-compatible firewall-mode rule string. If you don't specify a format, Network Firewall returns each embedded rule group in the format you provided it in. Referenced rule groups aren't affected.
      See Also:

    • ruleOutputFormatAsString

      public final String ruleOutputFormatAsString()

      The format in which to return the rules of any firewall engine rule groups that are embedded in the policy. Specify FIREWALL_RULES for structured FirewallRule objects or RULES_STRING for a Suricata-compatible firewall-mode rule string. If you don't specify a format, Network Firewall returns each embedded rule group in the format you provided it in. Referenced rule groups aren't affected.

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

      Returns:
      The format in which to return the rules of any firewall engine rule groups that are embedded in the policy. Specify FIREWALL_RULES for structured FirewallRule objects or RULES_STRING for a Suricata-compatible firewall-mode rule string. If you don't specify a format, Network Firewall returns each embedded rule group in the format you provided it in. Referenced rule groups aren't affected.
      See Also:

    • toBuilder

      public DescribeFirewallPolicyV2Request.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<DescribeFirewallPolicyV2Request.Builder,DescribeFirewallPolicyV2Request>
      Specified by:
      toBuilder in class NetworkFirewallRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeFirewallPolicyV2Request.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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