Package software.amazon.awssdk.services.waf.model

Interface Rule.Builder

All Superinterfaces:

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

Enclosing class:

Rule

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

Method Summary

Modifier and Type	Method	Description
Rule.Builder	metricName(String metricName)	A friendly name or description for the metrics for this Rule.
Rule.Builder	name(String name)	The friendly name or description for the Rule.
Rule.Builder	predicates(Collection<Predicate> predicates)	The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
Rule.Builder	predicates(Consumer<Predicate.Builder>... predicates)	The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
Rule.Builder	predicates(Predicate... predicates)	The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
Rule.Builder	ruleId(String ruleId)	A unique identifier for a Rule.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

ruleId

Rule.Builder ruleId(String ruleId)

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Parameters:

ruleId - A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Returns:

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

name

Rule.Builder name(String name)

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Parameters:

name - The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

Returns:

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

metricName

Rule.Builder metricName(String metricName)

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Parameters:

metricName - A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Returns:

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

predicates

Rule.Builder predicates(Collection<Predicate> predicates)

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Parameters:

predicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Returns:

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

predicates

Rule.Builder predicates(Predicate... predicates)

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Parameters:

predicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Returns:

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

predicates

Rule.Builder predicates(Consumer<Predicate.Builder>... predicates)

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #predicates(List).

Parameters:

predicates - a consumer that will call methods on Predicate.Builder

Returns:

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

See Also:

#predicates(java.util.Collection)