software.amazon.awssdk.services.waf.model.ByteMatchSet 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.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.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 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.
*
*
*
* In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the
* ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified
* when you updated the ByteMatchSet.
*
*
* A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you
* want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains
* more than one ByteMatchTuple object, a request needs to match the settings in only one
* ByteMatchTuple to be considered a match.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ByteMatchSet implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField BYTE_MATCH_SET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ByteMatchSetId").getter(getter(ByteMatchSet::byteMatchSetId)).setter(setter(Builder::byteMatchSetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ByteMatchSetId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ByteMatchSet::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> BYTE_MATCH_TUPLES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ByteMatchTuples")
.getter(getter(ByteMatchSet::byteMatchTuples))
.setter(setter(Builder::byteMatchTuples))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ByteMatchTuples").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ByteMatchTuple::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BYTE_MATCH_SET_ID_FIELD,
NAME_FIELD, BYTE_MATCH_TUPLES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("ByteMatchSetId", BYTE_MATCH_SET_ID_FIELD);
put("Name", NAME_FIELD);
put("ByteMatchTuples", BYTE_MATCH_TUPLES_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String byteMatchSetId;
private final String name;
private final List byteMatchTuples;
private ByteMatchSet(BuilderImpl builder) {
this.byteMatchSetId = builder.byteMatchSetId;
this.name = builder.name;
this.byteMatchTuples = builder.byteMatchTuples;
}
/**
*
* The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get
* information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet
* (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a
* Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see
* DeleteByteMatchSet).
*
*
* ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*
*
* @return The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to
* get information about a ByteMatchSet (see GetByteMatchSet), update a
* ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete a
* ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
*
* ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*/
public final String byteMatchSetId() {
return byteMatchSetId;
}
/**
*
* A friendly name or description of the ByteMatchSet. You can't change Name after you create a
* ByteMatchSet.
*
*
* @return A friendly name or description of the ByteMatchSet. You can't change Name after you
* create a ByteMatchSet.
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the ByteMatchTuples 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 hasByteMatchTuples() {
return byteMatchTuples != null && !(byteMatchTuples instanceof SdkAutoConstructList);
}
/**
*
* Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search
* for in web requests, the location in requests that you want AWS WAF to search, and other settings.
*
*
* 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 #hasByteMatchTuples} method.
*
*
* @return Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to
* search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
*/
public final List byteMatchTuples() {
return byteMatchTuples;
}
@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(byteMatchSetId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasByteMatchTuples() ? byteMatchTuples() : null);
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 ByteMatchSet)) {
return false;
}
ByteMatchSet other = (ByteMatchSet) obj;
return Objects.equals(byteMatchSetId(), other.byteMatchSetId()) && Objects.equals(name(), other.name())
&& hasByteMatchTuples() == other.hasByteMatchTuples()
&& Objects.equals(byteMatchTuples(), other.byteMatchTuples());
}
/**
* 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("ByteMatchSet").add("ByteMatchSetId", byteMatchSetId()).add("Name", name())
.add("ByteMatchTuples", hasByteMatchTuples() ? byteMatchTuples() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ByteMatchSetId":
return Optional.ofNullable(clazz.cast(byteMatchSetId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "ByteMatchTuples":
return Optional.ofNullable(clazz.cast(byteMatchTuples()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ByteMatchSet) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get
* information about a ByteMatchSet (see GetByteMatchSet), update a
* ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete a
* ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
*
*
* ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
*
*
* @param byteMatchSetId
* The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId
* to get information about a ByteMatchSet (see GetByteMatchSet), update a
* ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete a
* ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
*
* ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder byteMatchSetId(String byteMatchSetId);
/**
*
* A friendly name or description of the ByteMatchSet. You can't change Name after you
* create a ByteMatchSet.
*
*
* @param name
* A friendly name or description of the ByteMatchSet. You can't change Name after
* you create a ByteMatchSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to
* search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
*
*
* @param byteMatchTuples
* Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF
* to search for in web requests, the location in requests that you want AWS WAF to search, and other
* settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder byteMatchTuples(Collection byteMatchTuples);
/**
*
* Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to
* search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
*
*
* @param byteMatchTuples
* Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF
* to search for in web requests, the location in requests that you want AWS WAF to search, and other
* settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder byteMatchTuples(ByteMatchTuple... byteMatchTuples);
/**
*
* Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to
* search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.waf.model.ByteMatchTuple.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.waf.model.ByteMatchTuple#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.waf.model.ByteMatchTuple.Builder#build()} is called immediately and
* its result is passed to {@link #byteMatchTuples(List)}.
*
* @param byteMatchTuples
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.waf.model.ByteMatchTuple.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #byteMatchTuples(java.util.Collection)
*/
Builder byteMatchTuples(Consumer... byteMatchTuples);
}
static final class BuilderImpl implements Builder {
private String byteMatchSetId;
private String name;
private List byteMatchTuples = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ByteMatchSet model) {
byteMatchSetId(model.byteMatchSetId);
name(model.name);
byteMatchTuples(model.byteMatchTuples);
}
public final String getByteMatchSetId() {
return byteMatchSetId;
}
public final void setByteMatchSetId(String byteMatchSetId) {
this.byteMatchSetId = byteMatchSetId;
}
@Override
public final Builder byteMatchSetId(String byteMatchSetId) {
this.byteMatchSetId = byteMatchSetId;
return this;
}
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 List getByteMatchTuples() {
List result = ByteMatchTuplesCopier.copyToBuilder(this.byteMatchTuples);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setByteMatchTuples(Collection byteMatchTuples) {
this.byteMatchTuples = ByteMatchTuplesCopier.copyFromBuilder(byteMatchTuples);
}
@Override
public final Builder byteMatchTuples(Collection byteMatchTuples) {
this.byteMatchTuples = ByteMatchTuplesCopier.copy(byteMatchTuples);
return this;
}
@Override
@SafeVarargs
public final Builder byteMatchTuples(ByteMatchTuple... byteMatchTuples) {
byteMatchTuples(Arrays.asList(byteMatchTuples));
return this;
}
@Override
@SafeVarargs
public final Builder byteMatchTuples(Consumer... byteMatchTuples) {
byteMatchTuples(Stream.of(byteMatchTuples).map(c -> ByteMatchTuple.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ByteMatchSet build() {
return new ByteMatchSet(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}