software.amazon.awssdk.services.waf.model

Class UpdateWebAclRequest

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.UpdateWebAclRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateWebAclRequest.Builder,UpdateWebAclRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateWebAclRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateWebAclRequest.Builder	builder()
String	changeToken() The value returned by the most recent call to GetChangeToken.
WafAction	defaultAction() A default action for the web ACL, either ALLOW or BLOCK.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasUpdates() For responses, this returns true if the service returned a value for the Updates property.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateWebAclRequest.Builder>	serializableBuilderClass()
UpdateWebAclRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
List<WebACLUpdate>	updates() An array of updates to make to the WebACL.
String	webACLId() The WebACLId of the WebACL that you want to update.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

webACLId

public final String webACLId()

The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

Returns:

The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

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.

hasUpdates

public final boolean hasUpdates()

For responses, this returns true if the service returned a value for the Updates 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.

updates

public final List<WebACLUpdate> updates()

An array of updates to make to the WebACL.

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

• WebACLUpdate: Contains Action and ActivatedRule

• ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

• WafAction: Contains Type

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

Returns:

An array of updates to make to the WebACL.

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

• WebACLUpdate: Contains Action and ActivatedRule

• ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

• WafAction: Contains Type

defaultAction

public final WafAction defaultAction()

A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

Returns:

A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

toBuilder

public UpdateWebAclRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateWebAclRequest.Builder,UpdateWebAclRequest>

Specified by:

toBuilder in class WafRequest

Returns:

a builder for type T

builder

public static UpdateWebAclRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateWebAclRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.