Class RegexPatternSet
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RegexPatternSet.Builder,
RegexPatternSet>
Contains one or more regular expressions.
WAF assigns an ARN to each RegexPatternSet
that you create. To use a set in a rule, you provide the ARN
to the Rule statement RegexPatternSetReferenceStatement.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the entity.static RegexPatternSet.Builder
builder()
final String
A description of the set that helps with identification.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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RegularExpressionList property.final String
id()
A unique identifier for the set.final String
name()
The name of the set.The regular expression patterns in the set.static Class
<? extends RegexPatternSet.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the set. You cannot change the name after you create the set.
- Returns:
- The name of the set. You cannot change the name after you create the set.
-
id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Returns:
- A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
-
arn
The Amazon Resource Name (ARN) of the entity.
- Returns:
- The Amazon Resource Name (ARN) of the entity.
-
description
A description of the set that helps with identification.
- Returns:
- A description of the set that helps with identification.
-
hasRegularExpressionList
public final boolean hasRegularExpressionList()For responses, this returns true if the service returned a value for the RegularExpressionList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
regularExpressionList
The regular expression patterns in the set.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRegularExpressionList()
method.- Returns:
- The regular expression patterns in the set.
-
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<RegexPatternSet.Builder,
RegexPatternSet> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-