Class ListFirewallRuleDomainsQueryOptions
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ListFirewallRuleDomainsQueryOptions.Builder,ListFirewallRuleDomainsQueryOptions>
Optional filters and sort order for ListFirewallRuleDomains.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringReturns only the domains whose name contains this substring.Filters the returned domains by review status.final StringFilters the returned domains by review status.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()static Class<? extends ListFirewallRuleDomainsQueryOptions.Builder> final FirewallRuleDomainSortBysortBy()The attribute to sort the returned domains by.final StringThe attribute to sort the returned domains by.The sort direction:ASCfor ascending orDESCfor descending.final StringThe sort direction:ASCfor ascending orDESCfor descending.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 toALLOWEDwithin 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 theDENYoperation. A denied domain that is still queried and not blocked can move toALLOWED.
If you don't specify a value, the operation returns
OBSERVEDdomains.If the service returns an enum value that is not available in the current SDK version,
domainStatuswill returnFirewallDomainStatusFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdomainStatusAsString().- 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 toALLOWEDwithin 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 theDENYoperation. A denied domain that is still queried and not blocked can move toALLOWED.
If you don't specify a value, the operation returns
OBSERVEDdomains. -
- See Also:
-
-
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 toALLOWEDwithin 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 theDENYoperation. A denied domain that is still queried and not blocked can move toALLOWED.
If you don't specify a value, the operation returns
OBSERVEDdomains.If the service returns an enum value that is not available in the current SDK version,
domainStatuswill returnFirewallDomainStatusFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdomainStatusAsString().- 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 toALLOWEDwithin 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 theDENYoperation. A denied domain that is still queried and not blocked can move toALLOWED.
If you don't specify a value, the operation returns
OBSERVEDdomains. -
- See Also:
-
-
sortBy
The attribute to sort the returned domains by. Valid values:
-
TIME_ADDED- TheAddedTimeof the domain. -
DAILY_TOTAL- TheLast24HourRequestscount. -
TOTAL_REQUESTS- TheTotalRequestscount.
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,
sortBywill returnFirewallRuleDomainSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- The attribute to sort the returned domains by. Valid values:
-
TIME_ADDED- TheAddedTimeof the domain. -
DAILY_TOTAL- TheLast24HourRequestscount. -
TOTAL_REQUESTS- TheTotalRequestscount.
If you don't specify a value, the operation sorts by
TIME_ADDED. -
- See Also:
-
-
sortByAsString
The attribute to sort the returned domains by. Valid values:
-
TIME_ADDED- TheAddedTimeof the domain. -
DAILY_TOTAL- TheLast24HourRequestscount. -
TOTAL_REQUESTS- TheTotalRequestscount.
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,
sortBywill returnFirewallRuleDomainSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- The attribute to sort the returned domains by. Valid values:
-
TIME_ADDED- TheAddedTimeof the domain. -
DAILY_TOTAL- TheLast24HourRequestscount. -
TOTAL_REQUESTS- TheTotalRequestscount.
If you don't specify a value, the operation sorts by
TIME_ADDED. -
- See Also:
-
-
sortOrder
The sort direction:
ASCfor ascending orDESCfor 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,
sortOrderwill returnFirewallRuleDomainSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- The sort direction:
ASCfor ascending orDESCfor descending. If you don't specify a value, the operation sorts in descending order. - See Also:
-
sortOrderAsString
The sort direction:
ASCfor ascending orDESCfor 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,
sortOrderwill returnFirewallRuleDomainSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- The sort direction:
ASCfor ascending orDESCfor descending. If you don't specify a value, the operation sorts in descending order. - See Also:
-
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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ListFirewallRuleDomainsQueryOptions.Builder,ListFirewallRuleDomainsQueryOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ListFirewallRuleDomainsQueryOptions.Builder> serializableBuilderClass() -
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-