Package software.amazon.awssdk.services.networkfirewall.model

Class DescribeRuleGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest

software.amazon.awssdk.services.networkfirewall.model.DescribeRuleGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeRuleGroupRequest.Builder,DescribeRuleGroupRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeRuleGroupRequest
extends NetworkFirewallRequest
implements ToCopyableBuilder<DescribeRuleGroupRequest.Builder,DescribeRuleGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeRuleGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	analyzeRuleGroup()	Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing.
static DescribeRuleGroupRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ruleGroupArn()	The Amazon Resource Name (ARN) of the rule group.
String	ruleGroupName()	The descriptive name of the rule group.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeRuleGroupRequest.Builder>	serializableBuilderClass()
DescribeRuleGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RuleGroupType	type()	Indicates whether the rule group is stateless or stateful.
String	typeAsString()	Indicates whether the rule group is stateless or stateful.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

ruleGroupName

public final 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.

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.

ruleGroupArn

public final String ruleGroupArn()

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

Returns:

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

type

public final 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.

If the service returns an enum value that is not available in the current SDK version, type will return RuleGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

typeAsString

public final String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return RuleGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

analyzeRuleGroup

public final Boolean analyzeRuleGroup()

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

Returns:

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

toBuilder

public DescribeRuleGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRuleGroupRequest.Builder,DescribeRuleGroupRequest>

Specified by:

toBuilder in class NetworkFirewallRequest

builder

public static DescribeRuleGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeRuleGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo