Package software.amazon.awssdk.services.route53resolver.model

Class ListFirewallRulesRequest

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

  • Method Details

    • firewallRuleGroupId

      public final String firewallRuleGroupId()

      The unique identifier of the firewall rule group that you want to retrieve the rules for.

      Returns:
      The unique identifier of the firewall rule group that you want to retrieve the rules for.

    • priority

      public final Integer priority()

      Optional additional filter for the rules to retrieve.

      The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

      Returns:
      Optional additional filter for the rules to retrieve.

      The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

    • action

      public final Action action()

      Optional additional filter for the rules to retrieve.

      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

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

      Returns:
      Optional additional filter for the rules to retrieve.

      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

      See Also:

    • actionAsString

      public final String actionAsString()

      Optional additional filter for the rules to retrieve.

      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

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

      Returns:
      Optional additional filter for the rules to retrieve.

      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

      If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

      Returns:
      The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

      If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

    • nextToken

      public final String nextToken()

      For the first call to this list request, omit this value.

      When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

      Returns:
      For the first call to this list request, omit this value.

      When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

    • toBuilder

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

    • builder

      public static ListFirewallRulesRequest.Builder builder()

    • serializableBuilderClass

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