DescribeRuleGroupMetadataResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.networkfirewall.model.DescribeRuleGroupMetadataResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeRuleGroupMetadataResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeRuleGroupMetadataResult()

Constructors
Constructor and Description
`DescribeRuleGroupMetadataResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeRuleGroupMetadataResult`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getCapacity()` The maximum operating resources that this rule group can use.
`String`	`getDescription()` Returns the metadata objects for the specified rule group.
`Date`	`getLastModifiedTime()` The last time that the rule group was changed.
`String`	`getRuleGroupArn()` The descriptive name of the rule group.
`String`	`getRuleGroupName()` The descriptive name of the rule group.
`StatefulRuleOptions`	`getStatefulRuleOptions()`
`String`	`getType()` Indicates whether the rule group is stateless or stateful.
`int`	`hashCode()`
`void`	`setCapacity(Integer capacity)` The maximum operating resources that this rule group can use.
`void`	`setDescription(String description)` Returns the metadata objects for the specified rule group.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The last time that the rule group was changed.
`void`	`setRuleGroupArn(String ruleGroupArn)` The descriptive name of the rule group.
`void`	`setRuleGroupName(String ruleGroupName)` The descriptive name of the rule group.
`void`	`setStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)`
`void`	`setType(String type)` Indicates whether the rule group is stateless or stateful.
`String`	`toString()` Returns a string representation of this object.
`DescribeRuleGroupMetadataResult`	`withCapacity(Integer capacity)` The maximum operating resources that this rule group can use.
`DescribeRuleGroupMetadataResult`	`withDescription(String description)` Returns the metadata objects for the specified rule group.
`DescribeRuleGroupMetadataResult`	`withLastModifiedTime(Date lastModifiedTime)` The last time that the rule group was changed.
`DescribeRuleGroupMetadataResult`	`withRuleGroupArn(String ruleGroupArn)` The descriptive name of the rule group.
`DescribeRuleGroupMetadataResult`	`withRuleGroupName(String ruleGroupName)` The descriptive name of the rule group.
`DescribeRuleGroupMetadataResult`	`withStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)`
`DescribeRuleGroupMetadataResult`	`withType(RuleGroupType type)` Indicates whether the rule group is stateless or stateful.
`DescribeRuleGroupMetadataResult`	`withType(String type)` Indicates whether the rule group is stateless or stateful.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeRuleGroupMetadataResult
```
public DescribeRuleGroupMetadataResult()
```
- Method Detail
  - setRuleGroupArn
```
public void setRuleGroupArn(String ruleGroupArn)
```
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
    
    Parameters:
    
    ruleGroupArn - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
  - getRuleGroupArn
```
public String getRuleGroupArn()
```
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
    
    Returns:
    
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
  - withRuleGroupArn
```
public DescribeRuleGroupMetadataResult withRuleGroupArn(String ruleGroupArn)
```
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
    
    Parameters:
    
    ruleGroupArn - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
    
    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.
    
    You must specify the ARN or the name, and you can specify both.
    
    Parameters:
    
    ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
  - 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.
    
    You must specify the ARN or the name, and you can specify both.
    
    Returns:
    
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
  - withRuleGroupName
```
public DescribeRuleGroupMetadataResult withRuleGroupName(String ruleGroupName)
```
    The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
    
    Parameters:
    
    ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
    
    You must specify the ARN or the name, and you can specify both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Returns the metadata objects for the specified rule group.
    
    Parameters:
    
    description - Returns the metadata objects for the specified rule group.
  - getDescription
```
public String getDescription()
```
    Returns the metadata objects for the specified rule group.
    
    Returns:
    
    Returns the metadata objects for the specified rule group.
  - withDescription
```
public DescribeRuleGroupMetadataResult withDescription(String description)
```
    Returns the metadata objects for the specified rule group.
    
    Parameters:
    
    description - Returns the metadata objects for the specified 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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    See Also:
    
    RuleGroupType
  - withType
```
public DescribeRuleGroupMetadataResult 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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleGroupType
  - withType
```
public DescribeRuleGroupMetadataResult 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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    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 DescribeRuleGroupMetadataResult 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.
  - setStatefulRuleOptions
```
public void setStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)
```
    Parameters:
    
    statefulRuleOptions -
  - getStatefulRuleOptions
```
public StatefulRuleOptions getStatefulRuleOptions()
```
    Returns:
  - withStatefulRuleOptions
```
public DescribeRuleGroupMetadataResult withStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)
```
    Parameters:
    
    statefulRuleOptions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The last time that the rule group was changed.
    
    Parameters:
    
    lastModifiedTime - The last time that the rule group was changed.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The last time that the rule group was changed.
    
    Returns:
    
    The last time that the rule group was changed.
  - withLastModifiedTime
```
public DescribeRuleGroupMetadataResult withLastModifiedTime(Date lastModifiedTime)
```
    The last time that the rule group was changed.
    
    Parameters:
    
    lastModifiedTime - The last time that the rule group was changed.
    
    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 DescribeRuleGroupMetadataResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.600

Class DescribeRuleGroupMetadataResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeRuleGroupMetadataResult

Method Detail

setRuleGroupArn

getRuleGroupArn

withRuleGroupArn

setRuleGroupName

getRuleGroupName

withRuleGroupName

setDescription

getDescription

withDescription

setType

getType

withType

withType

setCapacity

getCapacity

withCapacity

setStatefulRuleOptions

getStatefulRuleOptions

withStatefulRuleOptions

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

toString

equals

hashCode

clone