software.amazon.awssdk.services.waf.model.CreateRateBasedRuleRequest 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.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.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 CreateRateBasedRuleRequest extends WafRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateRateBasedRuleRequest::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(CreateRateBasedRuleRequest::metricName)).setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricName").build()).build();
private static final SdkField RATE_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RateKey").getter(getter(CreateRateBasedRuleRequest::rateKeyAsString)).setter(setter(Builder::rateKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RateKey").build()).build();
private static final SdkField RATE_LIMIT_FIELD = SdkField. builder(MarshallingType.LONG).memberName("RateLimit")
.getter(getter(CreateRateBasedRuleRequest::rateLimit)).setter(setter(Builder::rateLimit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RateLimit").build()).build();
private static final SdkField CHANGE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ChangeToken").getter(getter(CreateRateBasedRuleRequest::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(CreateRateBasedRuleRequest::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,
RATE_KEY_FIELD, RATE_LIMIT_FIELD, CHANGE_TOKEN_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String name;
private final String metricName;
private final String rateKey;
private final Long rateLimit;
private final String changeToken;
private final List tags;
private CreateRateBasedRuleRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.metricName = builder.metricName;
this.rateKey = builder.rateKey;
this.rateLimit = builder.rateLimit;
this.changeToken = builder.changeToken;
this.tags = builder.tags;
}
/**
*
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*
*
* @return A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*/
public final String name() {
return name;
}
/**
*
* A friendly name or description for the metrics for this RateBasedRule. 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 RateBasedRule.
*
*
* @return A friendly name or description for the metrics for this RateBasedRule. 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 RateBasedRule.
*/
public final String metricName() {
return metricName;
}
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #rateKey} will
* return {@link RateKey#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #rateKeyAsString}.
*
*
* @return The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @see RateKey
*/
public final RateKey rateKey() {
return RateKey.fromValue(rateKey);
}
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #rateKey} will
* return {@link RateKey#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #rateKeyAsString}.
*
*
* @return The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @see RateKey
*/
public final String rateKeyAsString() {
return rateKey;
}
/**
*
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action
* that is specified for this rule.
*
*
* @return The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the
* action that is specified for this rule.
*/
public final Long rateLimit() {
return rateLimit;
}
/**
*
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can also
* use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*
*
* @return The ChangeToken that you used to submit the CreateRateBasedRule request. You
* can also use this value to query the status of the request. For more information, see
* GetChangeTokenStatus.
*/
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(rateKeyAsString());
hashCode = 31 * hashCode + Objects.hashCode(rateLimit());
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 CreateRateBasedRuleRequest)) {
return false;
}
CreateRateBasedRuleRequest other = (CreateRateBasedRuleRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(metricName(), other.metricName())
&& Objects.equals(rateKeyAsString(), other.rateKeyAsString()) && Objects.equals(rateLimit(), other.rateLimit())
&& 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("CreateRateBasedRuleRequest").add("Name", name()).add("MetricName", metricName())
.add("RateKey", rateKeyAsString()).add("RateLimit", rateLimit()).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 "RateKey":
return Optional.ofNullable(clazz.cast(rateKeyAsString()));
case "RateLimit":
return Optional.ofNullable(clazz.cast(rateLimit()));
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;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Name", NAME_FIELD);
map.put("MetricName", METRIC_NAME_FIELD);
map.put("RateKey", RATE_KEY_FIELD);
map.put("RateLimit", RATE_LIMIT_FIELD);
map.put("ChangeToken", CHANGE_TOKEN_FIELD);
map.put("Tags", TAGS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((CreateRateBasedRuleRequest) 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 RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*
*
* @param name
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
* @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 RateBasedRule. 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 RateBasedRule.
*
*
* @param metricName
* A friendly name or description for the metrics for this RateBasedRule. 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
* RateBasedRule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricName(String metricName);
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP. IP
* indicates that requests that arrive from the same IP address are subject to the RateLimit that
* is specified in the RateBasedRule.
*
*
* @param rateKey
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @see RateKey
* @return Returns a reference to this object so that method calls can be chained together.
* @see RateKey
*/
Builder rateKey(String rateKey);
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP. IP
* indicates that requests that arrive from the same IP address are subject to the RateLimit that
* is specified in the RateBasedRule.
*
*
* @param rateKey
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @see RateKey
* @return Returns a reference to this object so that method calls can be chained together.
* @see RateKey
*/
Builder rateKey(RateKey rateKey);
/**
*
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the
* action that is specified for this rule.
*
*
* @param rateLimit
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers
* the action that is specified for this rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rateLimit(Long rateLimit);
/**
*
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can
* also use this value to query the status of the request. For more information, see
* GetChangeTokenStatus.
*
*
* @param changeToken
* The ChangeToken that you used to submit the CreateRateBasedRule request. You
* can also use this value to query the status of the request. For more information, see
* GetChangeTokenStatus.
* @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 String rateKey;
private Long rateLimit;
private String changeToken;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateRateBasedRuleRequest model) {
super(model);
name(model.name);
metricName(model.metricName);
rateKey(model.rateKey);
rateLimit(model.rateLimit);
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 String getRateKey() {
return rateKey;
}
public final void setRateKey(String rateKey) {
this.rateKey = rateKey;
}
@Override
public final Builder rateKey(String rateKey) {
this.rateKey = rateKey;
return this;
}
@Override
public final Builder rateKey(RateKey rateKey) {
this.rateKey(rateKey == null ? null : rateKey.toString());
return this;
}
public final Long getRateLimit() {
return rateLimit;
}
public final void setRateLimit(Long rateLimit) {
this.rateLimit = rateLimit;
}
@Override
public final Builder rateLimit(Long rateLimit) {
this.rateLimit = rateLimit;
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 CreateRateBasedRuleRequest build() {
return new CreateRateBasedRuleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}