ManagedRuleSetSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.ManagedRuleSetSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ManagedRuleSetSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ManagedRuleSetSummary()

Constructors
Constructor and Description
`ManagedRuleSetSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ManagedRuleSetSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the entity.
`String`	`getDescription()` A description of the set that helps with identification.
`String`	`getId()` A unique identifier for the managed rule set.
`String`	`getLabelNamespace()` The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
`String`	`getLockToken()` A token used for optimistic locking.
`String`	`getName()` The name of the managed rule set.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`void`	`setDescription(String description)` A description of the set that helps with identification.
`void`	`setId(String id)` A unique identifier for the managed rule set.
`void`	`setLabelNamespace(String labelNamespace)` The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
`void`	`setLockToken(String lockToken)` A token used for optimistic locking.
`void`	`setName(String name)` The name of the managed rule set.
`String`	`toString()` Returns a string representation of this object.
`ManagedRuleSetSummary`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`ManagedRuleSetSummary`	`withDescription(String description)` A description of the set that helps with identification.
`ManagedRuleSetSummary`	`withId(String id)` A unique identifier for the managed rule set.
`ManagedRuleSetSummary`	`withLabelNamespace(String labelNamespace)` The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
`ManagedRuleSetSummary`	`withLockToken(String lockToken)` A token used for optimistic locking.
`ManagedRuleSetSummary`	`withName(String name)` The name of the managed rule set.

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

- Constructor Detail
  - ManagedRuleSetSummary
```
public ManagedRuleSetSummary()
```
- Method Detail
  - setName
```
public void setName(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.
    
    Parameters:
    
    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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public ManagedRuleSetSummary withName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(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.
    
    Parameters:
    
    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.
  - getId
```
public String getId()
```
    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.
  - withId
```
public ManagedRuleSetSummary withId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the set that helps with identification.
    
    Parameters:
    
    description - A description of the set that helps with identification.
  - getDescription
```
public String getDescription()
```
    A description of the set that helps with identification.
    
    Returns:
    
    A description of the set that helps with identification.
  - withDescription
```
public ManagedRuleSetSummary withDescription(String description)
```
    A description of the set that helps with identification.
    
    Parameters:
    
    description - A description of the set that helps with identification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLockToken
```
public void setLockToken(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.
    
    Parameters:
    
    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.
  - getLockToken
```
public String getLockToken()
```
    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.
  - withLockToken
```
public ManagedRuleSetSummary withLockToken(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withARN
```
public ManagedRuleSetSummary withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLabelNamespace
```
public void setLabelNamespace(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>
    Parameters:
    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>
  - getLabelNamespace
```
public String getLabelNamespace()
```
    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>
  - withLabelNamespace
```
public ManagedRuleSetSummary withLabelNamespace(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>
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ManagedRuleSetSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class ManagedRuleSetSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ManagedRuleSetSummary

Method Detail

setName

getName

withName

setId

getId

withId

setDescription

getDescription

withDescription

setLockToken

getLockToken

withLockToken

setARN

getARN

withARN

setLabelNamespace

getLabelNamespace

withLabelNamespace

toString

equals

hashCode

clone

marshall