RuleGroupResponse (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkfirewall.model.RuleGroupResponse

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroupResponse
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleGroupResponse()

Constructors
Constructor and Description
`RuleGroupResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuleGroupResponse`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getCapacity()` The maximum operating resources that this rule group can use.
`String`	`getDescription()` A description of the rule group.
`String`	`getRuleGroupArn()` The Amazon Resource Name (ARN) of the rule group.
`String`	`getRuleGroupId()` The unique identifier for the rule group.
`String`	`getRuleGroupName()` The descriptive name of the rule group.
`String`	`getRuleGroupStatus()` Detailed information about the current status of a rule group.
`List<Tag>`	`getTags()` The key:value pairs to associate with the resource.
`String`	`getType()` Indicates whether the rule group is stateless or stateful.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCapacity(Integer capacity)` The maximum operating resources that this rule group can use.
`void`	`setDescription(String description)` A description of the rule group.
`void`	`setRuleGroupArn(String ruleGroupArn)` The Amazon Resource Name (ARN) of the rule group.
`void`	`setRuleGroupId(String ruleGroupId)` The unique identifier for the rule group.
`void`	`setRuleGroupName(String ruleGroupName)` The descriptive name of the rule group.
`void`	`setRuleGroupStatus(String ruleGroupStatus)` Detailed information about the current status of a rule group.
`void`	`setTags(Collection<Tag> tags)` The key:value pairs to associate with the resource.
`void`	`setType(String type)` Indicates whether the rule group is stateless or stateful.
`String`	`toString()` Returns a string representation of this object.
`RuleGroupResponse`	`withCapacity(Integer capacity)` The maximum operating resources that this rule group can use.
`RuleGroupResponse`	`withDescription(String description)` A description of the rule group.
`RuleGroupResponse`	`withRuleGroupArn(String ruleGroupArn)` The Amazon Resource Name (ARN) of the rule group.
`RuleGroupResponse`	`withRuleGroupId(String ruleGroupId)` The unique identifier for the rule group.
`RuleGroupResponse`	`withRuleGroupName(String ruleGroupName)` The descriptive name of the rule group.
`RuleGroupResponse`	`withRuleGroupStatus(ResourceStatus ruleGroupStatus)` Detailed information about the current status of a rule group.
`RuleGroupResponse`	`withRuleGroupStatus(String ruleGroupStatus)` Detailed information about the current status of a rule group.
`RuleGroupResponse`	`withTags(Collection<Tag> tags)` The key:value pairs to associate with the resource.
`RuleGroupResponse`	`withTags(Tag... tags)` The key:value pairs to associate with the resource.
`RuleGroupResponse`	`withType(RuleGroupType type)` Indicates whether the rule group is stateless or stateful.
`RuleGroupResponse`	`withType(String type)` Indicates whether the rule group is stateless or stateful.

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

- Constructor Detail
  - RuleGroupResponse
```
public RuleGroupResponse()
```
- Method Detail
  - setRuleGroupArn
```
public void setRuleGroupArn(String ruleGroupArn)
```
    The Amazon Resource Name (ARN) of the rule group.
    
    If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
    
    Parameters:
    
    ruleGroupArn - The Amazon Resource Name (ARN) of the rule group.
    
    If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
  - getRuleGroupArn
```
public String getRuleGroupArn()
```
    The Amazon Resource Name (ARN) of the rule group.
    
    If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule group.
    
    If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
  - withRuleGroupArn
```
public RuleGroupResponse withRuleGroupArn(String ruleGroupArn)
```
    The Amazon Resource Name (ARN) of the rule group.
    
    If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
    
    Parameters:
    
    ruleGroupArn - The Amazon Resource Name (ARN) of the rule group.
    
    If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleGroupName
```
public void setRuleGroupName(String ruleGroupName)
```
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    Parameters:
    
    ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
  - getRuleGroupName
```
public String getRuleGroupName()
```
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    Returns:
    
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
  - withRuleGroupName
```
public RuleGroupResponse withRuleGroupName(String ruleGroupName)
```
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    Parameters:
    
    ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleGroupId
```
public void setRuleGroupId(String ruleGroupId)
```
    The unique identifier for the rule group.
    
    Parameters:
    
    ruleGroupId - The unique identifier for the rule group.
  - getRuleGroupId
```
public String getRuleGroupId()
```
    The unique identifier for the rule group.
    
    Returns:
    
    The unique identifier for the rule group.
  - withRuleGroupId
```
public RuleGroupResponse withRuleGroupId(String ruleGroupId)
```
    The unique identifier for the rule group.
    
    Parameters:
    
    ruleGroupId - The unique identifier for the rule group.
    
    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 rule group.
    
    Parameters:
    
    description - A description of the rule group.
  - getDescription
```
public String getDescription()
```
    A description of the rule group.
    
    Returns:
    
    A description of the rule group.
  - withDescription
```
public RuleGroupResponse withDescription(String description)
```
    A description of the rule group.
    
    Parameters:
    
    description - A description of the rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    Parameters:
    
    type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    See Also:
    
    RuleGroupType
  - getType
```
public String getType()
```
    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    Returns:
    
    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    See Also:
    
    RuleGroupType
  - withType
```
public RuleGroupResponse withType(String type)
```
    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    Parameters:
    
    type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleGroupType
  - withType
```
public RuleGroupResponse withType(RuleGroupType type)
```
    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    Parameters:
    
    type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleGroupType
  - setCapacity
```
public void setCapacity(Integer capacity)
```
    The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
    
    You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
    
    Parameters:
    
    capacity - The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
    
    You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
  - getCapacity
```
public Integer getCapacity()
```
    The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
    
    You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
    
    Returns:
    
    The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
    
    You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
  - withCapacity
```
public RuleGroupResponse withCapacity(Integer capacity)
```
    The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
    
    You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
    
    Parameters:
    
    capacity - The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
    
    You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleGroupStatus
```
public void setRuleGroupStatus(String ruleGroupStatus)
```
    Detailed information about the current status of a rule group.
    
    Parameters:
    
    ruleGroupStatus - Detailed information about the current status of a rule group.
    
    See Also:
    
    ResourceStatus
  - getRuleGroupStatus
```
public String getRuleGroupStatus()
```
    Detailed information about the current status of a rule group.
    
    Returns:
    
    Detailed information about the current status of a rule group.
    
    See Also:
    
    ResourceStatus
  - withRuleGroupStatus
```
public RuleGroupResponse withRuleGroupStatus(String ruleGroupStatus)
```
    Detailed information about the current status of a rule group.
    
    Parameters:
    
    ruleGroupStatus - Detailed information about the current status of a rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceStatus
  - withRuleGroupStatus
```
public RuleGroupResponse withRuleGroupStatus(ResourceStatus ruleGroupStatus)
```
    Detailed information about the current status of a rule group.
    
    Parameters:
    
    ruleGroupStatus - Detailed information about the current status of a rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceStatus
  - getTags
```
public List<Tag> getTags()
```
    The key:value pairs to associate with the resource.
    
    Returns:
    
    The key:value pairs to associate with the resource.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The key:value pairs to associate with the resource.
    
    Parameters:
    
    tags - The key:value pairs to associate with the resource.
  - withTags
```
public RuleGroupResponse withTags(Tag... tags)
```
    The key:value pairs to associate with the resource.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The key:value pairs to associate with the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public RuleGroupResponse withTags(Collection<Tag> tags)
```
    The key:value pairs to associate with the resource.
    
    Parameters:
    
    tags - The key:value pairs to associate with the resource.
    
    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 RuleGroupResponse 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 RuleGroupResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleGroupResponse

Method Detail

setRuleGroupArn

getRuleGroupArn

withRuleGroupArn

setRuleGroupName

getRuleGroupName

withRuleGroupName

setRuleGroupId

getRuleGroupId

withRuleGroupId

setDescription

getDescription

withDescription

setType

getType

withType

withType

setCapacity

getCapacity

withCapacity

setRuleGroupStatus

getRuleGroupStatus

withRuleGroupStatus

withRuleGroupStatus

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall