SubscribedRuleGroupSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.waf.model.SubscribedRuleGroupSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SubscribedRuleGroupSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

A summary of the rule groups you are subscribed to.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SubscribedRuleGroupSummary()

Constructors
Constructor and Description
`SubscribedRuleGroupSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubscribedRuleGroupSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getMetricName()` A friendly name or description for the metrics for this `RuleGroup`.
`String`	`getName()` A friendly name or description of the `RuleGroup`.
`String`	`getRuleGroupId()` A unique identifier for a `RuleGroup`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMetricName(String metricName)` A friendly name or description for the metrics for this `RuleGroup`.
`void`	`setName(String name)` A friendly name or description of the `RuleGroup`.
`void`	`setRuleGroupId(String ruleGroupId)` A unique identifier for a `RuleGroup`.
`String`	`toString()` Returns a string representation of this object.
`SubscribedRuleGroupSummary`	`withMetricName(String metricName)` A friendly name or description for the metrics for this `RuleGroup`.
`SubscribedRuleGroupSummary`	`withName(String name)` A friendly name or description of the `RuleGroup`.
`SubscribedRuleGroupSummary`	`withRuleGroupId(String ruleGroupId)` A unique identifier for a `RuleGroup`.

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

- Constructor Detail
  - SubscribedRuleGroupSummary
```
public SubscribedRuleGroupSummary()
```
- Method Detail
  - setRuleGroupId
```
public void setRuleGroupId(String ruleGroupId)
```
    A unique identifier for a RuleGroup.
    
    Parameters:
    
    ruleGroupId - A unique identifier for a RuleGroup.
  - getRuleGroupId
```
public String getRuleGroupId()
```
    A unique identifier for a RuleGroup.
    
    Returns:
    
    A unique identifier for a RuleGroup.
  - withRuleGroupId
```
public SubscribedRuleGroupSummary withRuleGroupId(String ruleGroupId)
```
    A unique identifier for a RuleGroup.
    
    Parameters:
    
    ruleGroupId - A unique identifier for a RuleGroup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
    
    Parameters:
    
    name - A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
  - getName
```
public String getName()
```
    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
    
    Returns:
    
    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
  - withName
```
public SubscribedRuleGroupSummary withName(String name)
```
    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
    
    Parameters:
    
    name - A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricName
```
public void setMetricName(String metricName)
```
    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
    
    Parameters:
    
    metricName - A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
  - getMetricName
```
public String getMetricName()
```
    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
    
    Returns:
    
    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
  - withMetricName
```
public SubscribedRuleGroupSummary withMetricName(String metricName)
```
    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
    
    Parameters:
    
    metricName - A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
    
    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 SubscribedRuleGroupSummary 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.

Did this page help you?

Class SubscribedRuleGroupSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubscribedRuleGroupSummary

Method Detail

setRuleGroupId

getRuleGroupId

withRuleGroupId

setName

getName

withName

setMetricName

getMetricName

withMetricName

toString

equals

hashCode

clone

marshall