@Generated(value="software.amazon.awssdk:codegen") public final class DescribeManagedRuleGroupResponse extends Wafv2Response implements ToCopyableBuilder<DescribeManagedRuleGroupResponse.Builder,DescribeManagedRuleGroupResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeManagedRuleGroupResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<LabelSummary> |
availableLabels()
The labels that one or more rules in this rule group add to matching web requests.
|
static DescribeManagedRuleGroupResponse.Builder |
builder() |
Long |
capacity()
The web ACL capacity units (WCUs) required for this rule group.
|
List<LabelSummary> |
consumedLabels()
The labels that one or more rules in this rule group match against in label match statements.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAvailableLabels()
For responses, this returns true if the service returned a value for the AvailableLabels property.
|
boolean |
hasConsumedLabels()
For responses, this returns true if the service returned a value for the ConsumedLabels property.
|
int |
hashCode() |
boolean |
hasRules()
For responses, this returns true if the service returned a value for the Rules property.
|
String |
labelNamespace()
The label namespace prefix for this rule group.
|
List<RuleSummary> |
rules()
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeManagedRuleGroupResponse.Builder> |
serializableBuilderClass() |
String |
snsTopicArn()
The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide
notification of changes to the managed rule group.
|
DescribeManagedRuleGroupResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionName()
The managed rule group's version.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String versionName()
The managed rule group's version.
public final String snsTopicArn()
The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
public final Long capacity()
The web ACL capacity units (WCUs) required for this rule group.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
public final boolean hasRules()
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.public final List<RuleSummary> rules()
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 hasRules() method.
public final String labelNamespace()
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
public final boolean hasAvailableLabels()
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.public final List<LabelSummary> availableLabels()
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in
the RuleLabels for a Rule.
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 hasAvailableLabels() method.
RuleLabels for a Rule.public final boolean hasConsumedLabels()
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.public final List<LabelSummary> consumedLabels()
The labels that one or more rules in this rule group match against in label match statements. These labels are
defined in a LabelMatchStatement specification, in the Statement definition of a rule.
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 hasConsumedLabels() method.
LabelMatchStatement specification, in the Statement
definition of a rule.public DescribeManagedRuleGroupResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeManagedRuleGroupResponse.Builder,DescribeManagedRuleGroupResponse>toBuilder in class AwsResponsepublic static DescribeManagedRuleGroupResponse.Builder builder()
public static Class<? extends DescribeManagedRuleGroupResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.