software.amazon.awssdk.services.wafv2.model.GeoMatchStatement Maven / Gradle / Ivy
/*
* 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.wafv2.model;
import java.io.Serializable;
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 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.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;
/**
*
*
* This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including
* how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
*
*
*
* A rule statement used to identify web requests based on country of origin.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GeoMatchStatement implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> COUNTRY_CODES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(GeoMatchStatement::countryCodesAsStrings))
.setter(setter(Builder::countryCodesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CountryCodes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField FORWARDED_IP_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).getter(getter(GeoMatchStatement::forwardedIPConfig))
.setter(setter(Builder::forwardedIPConfig)).constructor(ForwardedIPConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ForwardedIPConfig").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COUNTRY_CODES_FIELD,
FORWARDED_IP_CONFIG_FIELD));
private static final long serialVersionUID = 1L;
private final List countryCodes;
private final ForwardedIPConfig forwardedIPConfig;
private GeoMatchStatement(BuilderImpl builder) {
this.countryCodes = builder.countryCodes;
this.forwardedIPConfig = builder.forwardedIPConfig;
}
/**
*
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO
* codes of the ISO 3166 international standard.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasCountryCodes()} to see if a value was sent in this field.
*
*
* @return An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2
* country ISO codes of the ISO 3166 international standard.
*/
public List countryCodes() {
return CountryCodesCopier.copyStringToEnum(countryCodes);
}
/**
* Returns true if the CountryCodes 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.
*/
public boolean hasCountryCodes() {
return countryCodes != null && !(countryCodes instanceof SdkAutoConstructList);
}
/**
*
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO
* codes of the ISO 3166 international standard.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasCountryCodes()} to see if a value was sent in this field.
*
*
* @return An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2
* country ISO codes of the ISO 3166 international standard.
*/
public List countryCodesAsStrings() {
return countryCodes;
}
/**
*
* The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address
* that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can
* specify any header name.
*
*
*
* If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
*
*
*
* @return The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP
* address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header,
* but you can specify any header name.
*
* If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request
* at all.
*
*/
public ForwardedIPConfig forwardedIPConfig() {
return forwardedIPConfig;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(countryCodesAsStrings());
hashCode = 31 * hashCode + Objects.hashCode(forwardedIPConfig());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GeoMatchStatement)) {
return false;
}
GeoMatchStatement other = (GeoMatchStatement) obj;
return Objects.equals(countryCodesAsStrings(), other.countryCodesAsStrings())
&& Objects.equals(forwardedIPConfig(), other.forwardedIPConfig());
}
/**
* 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 String toString() {
return ToString.builder("GeoMatchStatement").add("CountryCodes", countryCodesAsStrings())
.add("ForwardedIPConfig", forwardedIPConfig()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CountryCodes":
return Optional.ofNullable(clazz.cast(countryCodesAsStrings()));
case "ForwardedIPConfig":
return Optional.ofNullable(clazz.cast(forwardedIPConfig()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GeoMatchStatement) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country
* ISO codes of the ISO 3166 international standard.
*
*
* @param countryCodes
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2
* country ISO codes of the ISO 3166 international standard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder countryCodesWithStrings(Collection countryCodes);
/**
*
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country
* ISO codes of the ISO 3166 international standard.
*
*
* @param countryCodes
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2
* country ISO codes of the ISO 3166 international standard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder countryCodesWithStrings(String... countryCodes);
/**
*
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country
* ISO codes of the ISO 3166 international standard.
*
*
* @param countryCodes
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2
* country ISO codes of the ISO 3166 international standard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder countryCodes(Collection countryCodes);
/**
*
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country
* ISO codes of the ISO 3166 international standard.
*
*
* @param countryCodes
* An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2
* country ISO codes of the ISO 3166 international standard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder countryCodes(CountryCode... countryCodes);
/**
*
* The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP
* address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but
* you can specify any header name.
*
*
*
* If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at
* all.
*
*
*
* @param forwardedIPConfig
* The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the
* IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF)
* header, but you can specify any header name.
*
* If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web
* request at all.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder forwardedIPConfig(ForwardedIPConfig forwardedIPConfig);
/**
*
* The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP
* address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but
* you can specify any header name.
*
*
*
* If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at
* all.
*
* This is a convenience that creates an instance of the {@link ForwardedIPConfig.Builder} avoiding the
* need to create one manually via {@link ForwardedIPConfig#builder()}.
*
* When the {@link Consumer} completes, {@link ForwardedIPConfig.Builder#build()} is called immediately and its
* result is passed to {@link #forwardedIPConfig(ForwardedIPConfig)}.
*
* @param forwardedIPConfig
* a consumer that will call methods on {@link ForwardedIPConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #forwardedIPConfig(ForwardedIPConfig)
*/
default Builder forwardedIPConfig(Consumer forwardedIPConfig) {
return forwardedIPConfig(ForwardedIPConfig.builder().applyMutation(forwardedIPConfig).build());
}
}
static final class BuilderImpl implements Builder {
private List countryCodes = DefaultSdkAutoConstructList.getInstance();
private ForwardedIPConfig forwardedIPConfig;
private BuilderImpl() {
}
private BuilderImpl(GeoMatchStatement model) {
countryCodesWithStrings(model.countryCodes);
forwardedIPConfig(model.forwardedIPConfig);
}
public final Collection getCountryCodes() {
return countryCodes;
}
@Override
public final Builder countryCodesWithStrings(Collection countryCodes) {
this.countryCodes = CountryCodesCopier.copy(countryCodes);
return this;
}
@Override
@SafeVarargs
public final Builder countryCodesWithStrings(String... countryCodes) {
countryCodesWithStrings(Arrays.asList(countryCodes));
return this;
}
@Override
public final Builder countryCodes(Collection countryCodes) {
this.countryCodes = CountryCodesCopier.copyEnumToString(countryCodes);
return this;
}
@Override
@SafeVarargs
public final Builder countryCodes(CountryCode... countryCodes) {
countryCodes(Arrays.asList(countryCodes));
return this;
}
public final void setCountryCodes(Collection countryCodes) {
this.countryCodes = CountryCodesCopier.copy(countryCodes);
}
public final ForwardedIPConfig.Builder getForwardedIPConfig() {
return forwardedIPConfig != null ? forwardedIPConfig.toBuilder() : null;
}
@Override
public final Builder forwardedIPConfig(ForwardedIPConfig forwardedIPConfig) {
this.forwardedIPConfig = forwardedIPConfig;
return this;
}
public final void setForwardedIPConfig(ForwardedIPConfig.BuilderImpl forwardedIPConfig) {
this.forwardedIPConfig = forwardedIPConfig != null ? forwardedIPConfig.build() : null;
}
@Override
public GeoMatchStatement build() {
return new GeoMatchStatement(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}