software.amazon.awssdk.services.wafv2.model

Interface JsonMatchPattern.Builder

All Superinterfaces:

Buildable, CopyableBuilder<JsonMatchPattern.Builder,JsonMatchPattern>, SdkBuilder<JsonMatchPattern.Builder,JsonMatchPattern>, SdkPojo

Enclosing class:

JsonMatchPattern

public static interface JsonMatchPattern.Builder
extends SdkPojo, CopyableBuilder<JsonMatchPattern.Builder,JsonMatchPattern>

Method Summary

Modifier and Type	Method and Description
JsonMatchPattern.Builder	all(All all) Match all of the elements.
default JsonMatchPattern.Builder	all(Consumer<All.Builder> all) Match all of the elements.
JsonMatchPattern.Builder	includedPaths(Collection<String> includedPaths) Match only the specified include paths.
JsonMatchPattern.Builder	includedPaths(String... includedPaths) Match only the specified include paths.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

all

JsonMatchPattern.Builder all(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

all

default JsonMatchPattern.Builder all(Consumer<All.Builder> all)

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

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

This is a convenience method that creates an instance of the All.Builder avoiding the need to create one manually via All.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to all(All).

Parameters:

all - a consumer that will call methods on All.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

all(All)

includedPaths

JsonMatchPattern.Builder includedPaths(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

includedPaths

JsonMatchPattern.Builder includedPaths(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.