software.amazon.awssdk.services.waf.model.WafOverrideAction Maven / Gradle / Ivy
Show all versions of waf Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.waf.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*
* This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
* developer guide.
*
*
* For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the
* latest version, AWS WAF has a single set of endpoints for regional and global use.
*
*
*
* The action to take if any rule within the RuleGroup matches a request.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class WafOverrideAction implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(WafOverrideAction::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String type;
private WafOverrideAction(BuilderImpl builder) {
this.type = builder.type;
}
/**
*
* COUNT overrides the action specified by the individual rule within a RuleGroup . If set
* to NONE, the rule's action will take place.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link WafOverrideActionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return COUNT overrides the action specified by the individual rule within a RuleGroup
* . If set to NONE, the rule's action will take place.
* @see WafOverrideActionType
*/
public final WafOverrideActionType type() {
return WafOverrideActionType.fromValue(type);
}
/**
*
* COUNT overrides the action specified by the individual rule within a RuleGroup . If set
* to NONE, the rule's action will take place.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link WafOverrideActionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return COUNT overrides the action specified by the individual rule within a RuleGroup
* . If set to NONE, the rule's action will take place.
* @see WafOverrideActionType
*/
public final String typeAsString() {
return type;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof WafOverrideAction)) {
return false;
}
WafOverrideAction other = (WafOverrideAction) obj;
return Objects.equals(typeAsString(), other.typeAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("WafOverrideAction").add("Type", typeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Type", TYPE_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((WafOverrideAction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* COUNT overrides the action specified by the individual rule within a RuleGroup . If
* set to NONE, the rule's action will take place.
*
*
* @param type
* COUNT overrides the action specified by the individual rule within a
* RuleGroup . If set to NONE, the rule's action will take place.
* @see WafOverrideActionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see WafOverrideActionType
*/
Builder type(String type);
/**
*
* COUNT overrides the action specified by the individual rule within a RuleGroup . If
* set to NONE, the rule's action will take place.
*
*
* @param type
* COUNT overrides the action specified by the individual rule within a
* RuleGroup . If set to NONE, the rule's action will take place.
* @see WafOverrideActionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see WafOverrideActionType
*/
Builder type(WafOverrideActionType type);
}
static final class BuilderImpl implements Builder {
private String type;
private BuilderImpl() {
}
private BuilderImpl(WafOverrideAction model) {
type(model.type);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(WafOverrideActionType type) {
this.type(type == null ? null : type.toString());
return this;
}
@Override
public WafOverrideAction build() {
return new WafOverrideAction(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}