software.amazon.awssdk.services.networkfirewall.model

Class DescribeRuleGroupMetadataResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallResponse

software.amazon.awssdk.services.networkfirewall.model.DescribeRuleGroupMetadataResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeRuleGroupMetadataResponse.Builder,DescribeRuleGroupMetadataResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeRuleGroupMetadataResponse
extends NetworkFirewallResponse
implements ToCopyableBuilder<DescribeRuleGroupMetadataResponse.Builder,DescribeRuleGroupMetadataResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeRuleGroupMetadataResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeRuleGroupMetadataResponse.Builder	builder()
Integer	capacity() The maximum operating resources that this rule group can use.
String	description() Returns the metadata objects for the specified rule group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime() The last time that the rule group was changed.
String	ruleGroupArn() The descriptive name of the rule group.
String	ruleGroupName() The descriptive name of the rule group.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeRuleGroupMetadataResponse.Builder>	serializableBuilderClass()
StatefulRuleOptions	statefulRuleOptions() Returns the value of the StatefulRuleOptions property for this object.
DescribeRuleGroupMetadataResponse.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.services.networkfirewall.model.NetworkFirewallResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

ruleGroupArn

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

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.

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.

description

public final String description()

Returns the metadata objects for the specified rule group.

Returns:

Returns the metadata objects for the specified rule group.

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

capacity

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

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.

statefulRuleOptions

public final StatefulRuleOptions statefulRuleOptions()

Returns the value of the StatefulRuleOptions property for this object.

Returns:

The value of the StatefulRuleOptions property for this object.

lastModifiedTime

public final Instant lastModifiedTime()

The last time that the rule group was changed.

Returns:

The last time that the rule group was changed.

toBuilder

public DescribeRuleGroupMetadataResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRuleGroupMetadataResponse.Builder,DescribeRuleGroupMetadataResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeRuleGroupMetadataResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo