software.amazon.awssdk.services.waf.model.SqlInjectionMatchSet 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.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.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.
*
*
*
* A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests
* that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the
* name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple
* object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be
* considered a match.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SqlInjectionMatchSet implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField SQL_INJECTION_MATCH_SET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SqlInjectionMatchSetId").getter(getter(SqlInjectionMatchSet::sqlInjectionMatchSetId))
.setter(setter(Builder::sqlInjectionMatchSetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SqlInjectionMatchSetId").build())
.build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(SqlInjectionMatchSet::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> SQL_INJECTION_MATCH_TUPLES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SqlInjectionMatchTuples")
.getter(getter(SqlInjectionMatchSet::sqlInjectionMatchTuples))
.setter(setter(Builder::sqlInjectionMatchTuples))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SqlInjectionMatchTuples").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SqlInjectionMatchTuple::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
SQL_INJECTION_MATCH_SET_ID_FIELD, NAME_FIELD, SQL_INJECTION_MATCH_TUPLES_FIELD));
private static final long serialVersionUID = 1L;
private final String sqlInjectionMatchSetId;
private final String name;
private final List sqlInjectionMatchTuples;
private SqlInjectionMatchSet(BuilderImpl builder) {
this.sqlInjectionMatchSetId = builder.sqlInjectionMatchSetId;
this.name = builder.name;
this.sqlInjectionMatchTuples = builder.sqlInjectionMatchTuples;
}
/**
*
* A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get
* information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a
* SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a
* SqlInjectionMatchSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see
* DeleteSqlInjectionMatchSet).
*
*
* SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
* ListSqlInjectionMatchSets.
*
*
* @return A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId
* to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update
* a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a
* SqlInjectionMatchSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see
* DeleteSqlInjectionMatchSet).
*
* SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
* ListSqlInjectionMatchSets.
*/
public final String sqlInjectionMatchSetId() {
return sqlInjectionMatchSetId;
}
/**
*
* The name, if any, of the SqlInjectionMatchSet.
*
*
* @return The name, if any, of the SqlInjectionMatchSet.
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the SqlInjectionMatchTuples 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 hasSqlInjectionMatchTuples() {
return sqlInjectionMatchTuples != null && !(sqlInjectionMatchTuples instanceof SdkAutoConstructList);
}
/**
*
* Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
*
*
* 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 #hasSqlInjectionMatchTuples} method.
*
*
* @return Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
*/
public final List sqlInjectionMatchTuples() {
return sqlInjectionMatchTuples;
}
@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(sqlInjectionMatchSetId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasSqlInjectionMatchTuples() ? sqlInjectionMatchTuples() : 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 SqlInjectionMatchSet)) {
return false;
}
SqlInjectionMatchSet other = (SqlInjectionMatchSet) obj;
return Objects.equals(sqlInjectionMatchSetId(), other.sqlInjectionMatchSetId()) && Objects.equals(name(), other.name())
&& hasSqlInjectionMatchTuples() == other.hasSqlInjectionMatchTuples()
&& Objects.equals(sqlInjectionMatchTuples(), other.sqlInjectionMatchTuples());
}
/**
* 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("SqlInjectionMatchSet").add("SqlInjectionMatchSetId", sqlInjectionMatchSetId())
.add("Name", name())
.add("SqlInjectionMatchTuples", hasSqlInjectionMatchTuples() ? sqlInjectionMatchTuples() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SqlInjectionMatchSetId":
return Optional.ofNullable(clazz.cast(sqlInjectionMatchSetId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "SqlInjectionMatchTuples":
return Optional.ofNullable(clazz.cast(sqlInjectionMatchTuples()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SqlInjectionMatchSet) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to
* get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a
* SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a
* SqlInjectionMatchSet into a Rule or delete one from a Rule (see
* UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see
* DeleteSqlInjectionMatchSet).
*
*
* SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
* ListSqlInjectionMatchSets.
*
*
* @param sqlInjectionMatchSetId
* A unique identifier for a SqlInjectionMatchSet. You use
* SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see
* GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see
* UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a
* Rule or delete one from a Rule (see UpdateRule), and delete a
* SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).
*
* SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
* ListSqlInjectionMatchSets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sqlInjectionMatchSetId(String sqlInjectionMatchSetId);
/**
*
* The name, if any, of the SqlInjectionMatchSet.
*
*
* @param name
* The name, if any, of the SqlInjectionMatchSet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
*
*
* @param sqlInjectionMatchTuples
* Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sqlInjectionMatchTuples(Collection sqlInjectionMatchTuples);
/**
*
* Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
*
*
* @param sqlInjectionMatchTuples
* Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sqlInjectionMatchTuples(SqlInjectionMatchTuple... sqlInjectionMatchTuples);
/**
*
* Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.waf.model.SqlInjectionMatchTuple.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.waf.model.SqlInjectionMatchTuple#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.waf.model.SqlInjectionMatchTuple.Builder#build()} is called
* immediately and its result is passed to {@link #sqlInjectionMatchTuples(List)}.
*
* @param sqlInjectionMatchTuples
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.waf.model.SqlInjectionMatchTuple.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sqlInjectionMatchTuples(java.util.Collection)
*/
Builder sqlInjectionMatchTuples(Consumer... sqlInjectionMatchTuples);
}
static final class BuilderImpl implements Builder {
private String sqlInjectionMatchSetId;
private String name;
private List sqlInjectionMatchTuples = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SqlInjectionMatchSet model) {
sqlInjectionMatchSetId(model.sqlInjectionMatchSetId);
name(model.name);
sqlInjectionMatchTuples(model.sqlInjectionMatchTuples);
}
public final String getSqlInjectionMatchSetId() {
return sqlInjectionMatchSetId;
}
public final void setSqlInjectionMatchSetId(String sqlInjectionMatchSetId) {
this.sqlInjectionMatchSetId = sqlInjectionMatchSetId;
}
@Override
public final Builder sqlInjectionMatchSetId(String sqlInjectionMatchSetId) {
this.sqlInjectionMatchSetId = sqlInjectionMatchSetId;
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 getSqlInjectionMatchTuples() {
List result = SqlInjectionMatchTuplesCopier
.copyToBuilder(this.sqlInjectionMatchTuples);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSqlInjectionMatchTuples(Collection sqlInjectionMatchTuples) {
this.sqlInjectionMatchTuples = SqlInjectionMatchTuplesCopier.copyFromBuilder(sqlInjectionMatchTuples);
}
@Override
public final Builder sqlInjectionMatchTuples(Collection sqlInjectionMatchTuples) {
this.sqlInjectionMatchTuples = SqlInjectionMatchTuplesCopier.copy(sqlInjectionMatchTuples);
return this;
}
@Override
@SafeVarargs
public final Builder sqlInjectionMatchTuples(SqlInjectionMatchTuple... sqlInjectionMatchTuples) {
sqlInjectionMatchTuples(Arrays.asList(sqlInjectionMatchTuples));
return this;
}
@Override
@SafeVarargs
public final Builder sqlInjectionMatchTuples(Consumer... sqlInjectionMatchTuples) {
sqlInjectionMatchTuples(Stream.of(sqlInjectionMatchTuples)
.map(c -> SqlInjectionMatchTuple.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public SqlInjectionMatchSet build() {
return new SqlInjectionMatchSet(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}