Class DescribeRuleGroupMetadataRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeRuleGroupMetadataRequest.Builder,
DescribeRuleGroupMetadataRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The descriptive name of the rule group.final String
The descriptive name of the rule group.static Class
<? extends DescribeRuleGroupMetadataRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final RuleGroupType
type()
Indicates whether the rule group is stateless or stateful.final String
Indicates whether the rule group is stateless or stateful.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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.
-
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 returnRuleGroupType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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:
-
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 returnRuleGroupType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeRuleGroupMetadataRequest.Builder,
DescribeRuleGroupMetadataRequest> - Specified by:
toBuilder
in classNetworkFirewallRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-