@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class JsonMatchPattern extends Object implements Serializable, Cloneable, StructuredPojo
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule
inspection criteria. This is used with the FieldToMatch option JsonBody
.
Constructor and Description |
---|
JsonMatchPattern() |
Modifier and Type | Method and Description |
---|---|
JsonMatchPattern |
clone() |
boolean |
equals(Object obj) |
All |
getAll()
Match all of the elements.
|
List<String> |
getIncludedPaths()
Match only the specified include paths.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAll(All all)
Match all of the elements.
|
void |
setIncludedPaths(Collection<String> includedPaths)
Match only the specified include paths.
|
String |
toString()
Returns a string representation of this object.
|
JsonMatchPattern |
withAll(All all)
Match all of the elements.
|
JsonMatchPattern |
withIncludedPaths(Collection<String> includedPaths)
Match only the specified include paths.
|
JsonMatchPattern |
withIncludedPaths(String... includedPaths)
Match only the specified include paths.
|
public void setAll(All all)
Match all of the elements. See also MatchScope
in JsonBody.
You must specify either this setting or the IncludedPaths
setting, but not both.
all
- Match all of the elements. See also MatchScope
in JsonBody.
You must specify either this setting or the IncludedPaths
setting, but not both.
public All getAll()
Match all of the elements. See also MatchScope
in JsonBody.
You must specify either this setting or the IncludedPaths
setting, but not both.
MatchScope
in JsonBody.
You must specify either this setting or the IncludedPaths
setting, but not both.
public JsonMatchPattern withAll(All all)
Match all of the elements. See also MatchScope
in JsonBody.
You must specify either this setting or the IncludedPaths
setting, but not both.
all
- Match all of the elements. See also MatchScope
in JsonBody.
You must specify either this setting or the IncludedPaths
setting, but not both.
public List<String> getIncludedPaths()
Match only the specified include paths. See also MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript
Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see
the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
public void setIncludedPaths(Collection<String> includedPaths)
Match only the specified include paths. See also MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript
Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
includedPaths
- Match only the specified include paths. See also MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
public JsonMatchPattern withIncludedPaths(String... includedPaths)
Match only the specified include paths. See also MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript
Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
NOTE: This method appends the values to the existing list (if any). Use
setIncludedPaths(java.util.Collection)
or withIncludedPaths(java.util.Collection)
if you want
to override the existing values.
includedPaths
- Match only the specified include paths. See also MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
public JsonMatchPattern withIncludedPaths(Collection<String> includedPaths)
Match only the specified include paths. See also MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript
Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
includedPaths
- Match only the specified include paths. See also MatchScope
in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
You must specify either this setting or the All
setting, but not both.
Don't use this option to include all paths. Instead, use the All
setting.
public String toString()
toString
in class Object
Object.toString()
public JsonMatchPattern clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.