Class ListFirewallRuleDomainsQueryOptions

java.lang.Object
software.amazon.awssdk.services.route53resolver.model.ListFirewallRuleDomainsQueryOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ListFirewallRuleDomainsQueryOptions.Builder,ListFirewallRuleDomainsQueryOptions>

@Generated("software.amazon.awssdk:codegen") public final class ListFirewallRuleDomainsQueryOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ListFirewallRuleDomainsQueryOptions.Builder,ListFirewallRuleDomainsQueryOptions>

Optional filters and sort order for ListFirewallRuleDomains.

See Also:
  • Method Details

    • domainStatus

      public final FirewallDomainStatusFilter domainStatus()

      Filters the returned domains by review status. Valid values:

      • OBSERVED - Domains that DNS Firewall saw in the VPCs' DNS traffic and that you haven't allowed or denied. After the look-back window, a domain is observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created.

      • ALLOWED - Domains that DNS Firewall allowed queries for, whether or not they're in the rule's managed domain list.

      • DENIED - Domains that were denied with the DENY operation. A denied domain that is still queried and not blocked can move to ALLOWED.

      If you don't specify a value, the operation returns OBSERVED domains.

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

      Returns:
      Filters the returned domains by review status. Valid values:

      • OBSERVED - Domains that DNS Firewall saw in the VPCs' DNS traffic and that you haven't allowed or denied. After the look-back window, a domain is observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created.

      • ALLOWED - Domains that DNS Firewall allowed queries for, whether or not they're in the rule's managed domain list.

      • DENIED - Domains that were denied with the DENY operation. A denied domain that is still queried and not blocked can move to ALLOWED.

      If you don't specify a value, the operation returns OBSERVED domains.

      See Also:
    • domainStatusAsString

      public final String domainStatusAsString()

      Filters the returned domains by review status. Valid values:

      • OBSERVED - Domains that DNS Firewall saw in the VPCs' DNS traffic and that you haven't allowed or denied. After the look-back window, a domain is observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created.

      • ALLOWED - Domains that DNS Firewall allowed queries for, whether or not they're in the rule's managed domain list.

      • DENIED - Domains that were denied with the DENY operation. A denied domain that is still queried and not blocked can move to ALLOWED.

      If you don't specify a value, the operation returns OBSERVED domains.

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

      Returns:
      Filters the returned domains by review status. Valid values:

      • OBSERVED - Domains that DNS Firewall saw in the VPCs' DNS traffic and that you haven't allowed or denied. After the look-back window, a domain is observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created.

      • ALLOWED - Domains that DNS Firewall allowed queries for, whether or not they're in the rule's managed domain list.

      • DENIED - Domains that were denied with the DENY operation. A denied domain that is still queried and not blocked can move to ALLOWED.

      If you don't specify a value, the operation returns OBSERVED domains.

      See Also:
    • sortBy

      public final FirewallRuleDomainSortBy sortBy()

      The attribute to sort the returned domains by. Valid values:

      • TIME_ADDED - The AddedTime of the domain.

      • DAILY_TOTAL - The Last24HourRequests count.

      • TOTAL_REQUESTS - The TotalRequests count.

      If you don't specify a value, the operation sorts by TIME_ADDED.

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

      Returns:
      The attribute to sort the returned domains by. Valid values:

      • TIME_ADDED - The AddedTime of the domain.

      • DAILY_TOTAL - The Last24HourRequests count.

      • TOTAL_REQUESTS - The TotalRequests count.

      If you don't specify a value, the operation sorts by TIME_ADDED.

      See Also:
    • sortByAsString

      public final String sortByAsString()

      The attribute to sort the returned domains by. Valid values:

      • TIME_ADDED - The AddedTime of the domain.

      • DAILY_TOTAL - The Last24HourRequests count.

      • TOTAL_REQUESTS - The TotalRequests count.

      If you don't specify a value, the operation sorts by TIME_ADDED.

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

      Returns:
      The attribute to sort the returned domains by. Valid values:

      • TIME_ADDED - The AddedTime of the domain.

      • DAILY_TOTAL - The Last24HourRequests count.

      • TOTAL_REQUESTS - The TotalRequests count.

      If you don't specify a value, the operation sorts by TIME_ADDED.

      See Also:
    • sortOrder

      public final FirewallRuleDomainSortOrder sortOrder()

      The sort direction: ASC for ascending or DESC for descending. If you don't specify a value, the operation sorts in descending order.

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

      Returns:
      The sort direction: ASC for ascending or DESC for descending. If you don't specify a value, the operation sorts in descending order.
      See Also:
    • sortOrderAsString

      public final String sortOrderAsString()

      The sort direction: ASC for ascending or DESC for descending. If you don't specify a value, the operation sorts in descending order.

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

      Returns:
      The sort direction: ASC for ascending or DESC for descending. If you don't specify a value, the operation sorts in descending order.
      See Also:
    • domainNameFilter

      public final String domainNameFilter()

      Returns only the domains whose name contains this substring.

      Returns:
      Returns only the domains whose name contains this substring.
    • 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<ListFirewallRuleDomainsQueryOptions.Builder,ListFirewallRuleDomainsQueryOptions>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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