Package software.amazon.awssdk.services.wafv2.model

Class JsonMatchPattern

java.lang.Object

software.amazon.awssdk.services.wafv2.model.JsonMatchPattern

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JsonMatchPattern.Builder,JsonMatchPattern>

@Generated("software.amazon.awssdk:codegen")
public final class JsonMatchPattern
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JsonMatchPattern.Builder,JsonMatchPattern>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JsonMatchPattern.Builder

Method Summary

Modifier and Type	Method	Description
All	all()	Match all of the elements.
static JsonMatchPattern.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIncludedPaths()	For responses, this returns true if the service returned a value for the IncludedPaths property.
List<String>	includedPaths()	Match only the specified include paths.
List<SdkField<?>>	sdkFields()
static Class<? extends JsonMatchPattern.Builder>	serializableBuilderClass()
JsonMatchPattern.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

all

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

Returns:

Match all of the elements. See also MatchScope in JsonBody.

You must specify either this setting or the IncludedPaths setting, but not both.

hasIncludedPaths

public final boolean hasIncludedPaths()

For responses, this returns true if the service returned a value for the IncludedPaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

includedPaths

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

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 hasIncludedPaths() method.

Returns:

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.

toBuilder

public JsonMatchPattern.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JsonMatchPattern.Builder,JsonMatchPattern>

builder

public static JsonMatchPattern.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo