software.amazon.awssdk.services.waf.model

Class CreateRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.waf.model.WafRequest

software.amazon.awssdk.services.waf.model.CreateRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRuleRequest
extends WafRequest
implements ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRuleRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateRuleRequest.Builder	builder()
String	changeToken() The value returned by the most recent call to GetChangeToken.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	metricName() A friendly name or description for the metrics for this Rule.
String	name() A friendly name or description of the Rule.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRuleRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()
CreateRuleRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

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

Returns:

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

metricName

public final 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 the name of the metric after you create the Rule.

Returns:

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 the name of the metric after you create the Rule.

changeToken

public final String changeToken()

The value returned by the most recent call to GetChangeToken.

Returns:

The value returned by the most recent call to GetChangeToken.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

toBuilder

public CreateRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Specified by:

toBuilder in class WafRequest

builder

public static CreateRuleRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo