software.amazon.awssdk.services.waf.model.CreateWebAclRequest 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.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateWebAclRequest extends WafRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateWebAclRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MetricName").getter(getter(CreateWebAclRequest::metricName)).setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricName").build()).build();
private static final SdkField DEFAULT_ACTION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("DefaultAction").getter(getter(CreateWebAclRequest::defaultAction))
.setter(setter(Builder::defaultAction)).constructor(WafAction::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultAction").build()).build();
private static final SdkField CHANGE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ChangeToken").getter(getter(CreateWebAclRequest::changeToken)).setter(setter(Builder::changeToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChangeToken").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateWebAclRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, METRIC_NAME_FIELD,
DEFAULT_ACTION_FIELD, CHANGE_TOKEN_FIELD, TAGS_FIELD));
private final String name;
private final String metricName;
private final WafAction defaultAction;
private final String changeToken;
private final List tags;
private CreateWebAclRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.metricName = builder.metricName;
this.defaultAction = builder.defaultAction;
this.changeToken = builder.changeToken;
this.tags = builder.tags;
}
/**
*
* A friendly name or description of the WebACL. You can't change Name after you create the
* WebACL.
*
*
* @return A friendly name or description of the WebACL. You can't change Name after you create
* the WebACL.
*/
public final String name() {
return name;
}
/**
*
* A friendly name or description for the metrics for this WebACL.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 WebACL.
*
*
* @return A friendly name or description for the metrics for this WebACL.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 WebACL.
*/
public final String metricName() {
return metricName;
}
/**
*
* The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the
* Rule objects that are associated with the WebACL.
*
*
* @return The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of
* the Rule objects that are associated with the WebACL.
*/
public final WafAction defaultAction() {
return defaultAction;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @return The value returned by the most recent call to GetChangeToken.
*/
public final String changeToken() {
return changeToken;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
*
* 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 {@link #hasTags} method.
*
*
* @return
*/
public final List tags() {
return tags;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(defaultAction());
hashCode = 31 * hashCode + Objects.hashCode(changeToken());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateWebAclRequest)) {
return false;
}
CreateWebAclRequest other = (CreateWebAclRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(metricName(), other.metricName())
&& Objects.equals(defaultAction(), other.defaultAction()) && Objects.equals(changeToken(), other.changeToken())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("CreateWebAclRequest").add("Name", name()).add("MetricName", metricName())
.add("DefaultAction", defaultAction()).add("ChangeToken", changeToken()).add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "MetricName":
return Optional.ofNullable(clazz.cast(metricName()));
case "DefaultAction":
return Optional.ofNullable(clazz.cast(defaultAction()));
case "ChangeToken":
return Optional.ofNullable(clazz.cast(changeToken()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateWebAclRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WafRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A friendly name or description of the WebACL. You can't change Name after you create the
* WebACL.
*
*
* @param name
* A friendly name or description of the WebACL. You can't change Name after you
* create the WebACL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A friendly name or description for the metrics for this WebACL.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 WebACL.
*
*
* @param metricName
* A friendly name or description for the metrics for this WebACL.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 WebACL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricName(String metricName);
/**
*
* The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the
* Rule objects that are associated with the WebACL.
*
*
* @param defaultAction
* The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of
* the Rule objects that are associated with the WebACL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultAction(WafAction defaultAction);
/**
*
* The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the
* Rule objects that are associated with the WebACL.
*
* This is a convenience method that creates an instance of the {@link WafAction.Builder} avoiding the need to
* create one manually via {@link WafAction#builder()}.
*
*
* When the {@link Consumer} completes, {@link WafAction.Builder#build()} is called immediately and its result
* is passed to {@link #defaultAction(WafAction)}.
*
* @param defaultAction
* a consumer that will call methods on {@link WafAction.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #defaultAction(WafAction)
*/
default Builder defaultAction(Consumer defaultAction) {
return defaultAction(WafAction.builder().applyMutation(defaultAction).build());
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @param changeToken
* The value returned by the most recent call to GetChangeToken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder changeToken(String changeToken);
/**
*
*
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
*
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.waf.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.waf.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.waf.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.waf.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WafRequest.BuilderImpl implements Builder {
private String name;
private String metricName;
private WafAction defaultAction;
private String changeToken;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateWebAclRequest model) {
super(model);
name(model.name);
metricName(model.metricName);
defaultAction(model.defaultAction);
changeToken(model.changeToken);
tags(model.tags);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getMetricName() {
return metricName;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
public final WafAction.Builder getDefaultAction() {
return defaultAction != null ? defaultAction.toBuilder() : null;
}
public final void setDefaultAction(WafAction.BuilderImpl defaultAction) {
this.defaultAction = defaultAction != null ? defaultAction.build() : null;
}
@Override
public final Builder defaultAction(WafAction defaultAction) {
this.defaultAction = defaultAction;
return this;
}
public final String getChangeToken() {
return changeToken;
}
public final void setChangeToken(String changeToken) {
this.changeToken = changeToken;
}
@Override
public final Builder changeToken(String changeToken) {
this.changeToken = changeToken;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateWebAclRequest build() {
return new CreateWebAclRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}