ManagedRuleSetSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.wafv2.model.ManagedRuleSetSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ManagedRuleSetSummary.Builder,ManagedRuleSetSummary>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ManagedRuleSetSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ManagedRuleSetSummary.Builder,ManagedRuleSetSummary>
```
High-level information for a managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ManagedRuleSetSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ManagedRuleSetSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the entity.
`static ManagedRuleSetSummary.Builder`	`builder()`
`String`	`description()` A description of the set that helps with identification.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` A unique identifier for the managed rule set.
`String`	`labelNamespace()` The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
`String`	`lockToken()` A token used for optimistic locking.
`String`	`name()` The name of the managed rule set.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ManagedRuleSetSummary.Builder>`	`serializableBuilderClass()`
`ManagedRuleSetSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
    
    This name is assigned to the corresponding managed rule group, which your customers can access and use.
    
    Returns:
    
    The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
    
    This name is assigned to the corresponding managed rule group, which your customers can access and use.
  - id
```
public final String id()
```
    A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
    
    Returns:
    
    A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
  - description
```
public final String description()
```
    A description of the set that helps with identification.
    
    Returns:
    
    A description of the set that helps with identification.
  - lockToken
```
public final String lockToken()
```
    A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
    
    Returns:
    
    A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - labelNamespace
```
public final String labelNamespace()
```
    The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed 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>
    Returns:
    The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed 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>
  - toBuilder
```
public ManagedRuleSetSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ManagedRuleSetSummary.Builder,ManagedRuleSetSummary>
  - builder
```
public static ManagedRuleSetSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ManagedRuleSetSummary.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ManagedRuleSetSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

id

description

lockToken

arn

labelNamespace

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields