software.amazon.awssdk.services.waf.model.ByteMatchTuple 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.nio.ByteBuffer;
import java.util.Arrays;
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.SdkBytes;
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.LocationTrait;
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.
*
*
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ByteMatchTuple implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField FIELD_TO_MATCH_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("FieldToMatch").getter(getter(ByteMatchTuple::fieldToMatch)).setter(setter(Builder::fieldToMatch))
.constructor(FieldToMatch::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FieldToMatch").build()).build();
private static final SdkField TARGET_STRING_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("TargetString").getter(getter(ByteMatchTuple::targetString)).setter(setter(Builder::targetString))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetString").build()).build();
private static final SdkField TEXT_TRANSFORMATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TextTransformation").getter(getter(ByteMatchTuple::textTransformationAsString))
.setter(setter(Builder::textTransformation))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TextTransformation").build())
.build();
private static final SdkField POSITIONAL_CONSTRAINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PositionalConstraint").getter(getter(ByteMatchTuple::positionalConstraintAsString))
.setter(setter(Builder::positionalConstraint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PositionalConstraint").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FIELD_TO_MATCH_FIELD,
TARGET_STRING_FIELD, TEXT_TRANSFORMATION_FIELD, POSITIONAL_CONSTRAINT_FIELD));
private static final long serialVersionUID = 1L;
private final FieldToMatch fieldToMatch;
private final SdkBytes targetString;
private final String textTransformation;
private final String positionalConstraint;
private ByteMatchTuple(BuilderImpl builder) {
this.fieldToMatch = builder.fieldToMatch;
this.targetString = builder.targetString;
this.textTransformation = builder.textTransformation;
this.positionalConstraint = builder.positionalConstraint;
}
/**
*
* The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more
* information, see FieldToMatch.
*
*
* @return The part of a web request that you want AWS WAF to search, such as a specified header or a query string.
* For more information, see FieldToMatch.
*/
public final FieldToMatch fieldToMatch() {
return fieldToMatch;
}
/**
*
* The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web
* requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
*
*
* Valid values depend on the values that you specified for FieldToMatch:
*
*
* -
*
* HEADER: The value that you want AWS WAF to search for in the request header that you specified in
* FieldToMatch, for example, the value of the User-Agent or Referer header.
*
*
* -
*
* METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront
* supports the following methods: DELETE, GET, HEAD, OPTIONS,
* PATCH, POST, and PUT.
*
*
* -
*
* QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part
* of a URL that appears after a ? character.
*
*
* -
*
* URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource,
* for example, /images/daily-ad.jpg.
*
*
* -
*
* BODY: The part of a request that contains any additional data that you want to send to your web
* server as the HTTP request body, such as data from a form. The request body immediately follows the request
* headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for
* inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For
* more information, see CreateSizeConstraintSet.
*
*
* -
*
* SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName
* or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
*
*
* -
*
* ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single
* parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you
* specify in TargetString.
*
*
*
*
* If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
*
*
* If you're using the AWS WAF API
*
*
* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50
* bytes.
*
*
* For example, suppose the value of Type is HEADER and the value of Data is
* User-Agent. If you want to search the User-Agent header for the value
* BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting
* value, QmFkQm90, in the value of TargetString.
*
*
* If you're using the AWS CLI or one of the AWS SDKs
*
*
* The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
*
*
* @return The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of
* web requests that you specified in FieldToMatch. The maximum length of the value is 50
* bytes.
*
* Valid values depend on the values that you specified for FieldToMatch:
*
*
* -
*
* HEADER: The value that you want AWS WAF to search for in the request header that you
* specified in FieldToMatch, for example, the value of the User-Agent or
* Referer header.
*
*
* -
*
* METHOD: The HTTP method, which indicates the type of operation specified in the request.
* CloudFront supports the following methods: DELETE, GET, HEAD,
* OPTIONS, PATCH, POST, and PUT.
*
*
* -
*
* QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is
* the part of a URL that appears after a ? character.
*
*
* -
*
* URI: The value that you want AWS WAF to search for in the part of a URL that identifies a
* resource, for example, /images/daily-ad.jpg.
*
*
* -
*
* BODY: The part of a request that contains any additional data that you want to send to your
* web server as the HTTP request body, such as data from a form. The request body immediately follows the
* request headers. Note that only the first 8192 bytes of the request body are forwarded to
* AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size
* constraint set. For more information, see CreateSizeConstraintSet.
*
*
* -
*
* SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as
* UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30
* characters.
*
*
* -
*
* ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single
* parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that
* you specify in TargetString.
*
*
*
*
* If TargetString includes alphabetic characters A-Z and a-z, note that the value is case
* sensitive.
*
*
* If you're using the AWS WAF API
*
*
* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode
* it is 50 bytes.
*
*
* For example, suppose the value of Type is HEADER and the value of
* Data is User-Agent. If you want to search the User-Agent header
* for the value BadBot, you base64-encode BadBot using MIME base64-encoding and
* include the resulting value, QmFkQm90, in the value of TargetString.
*
*
* If you're using the AWS CLI or one of the AWS SDKs
*
*
* The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
*/
public final SdkBytes targetString() {
return targetString;
}
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
* bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
* before inspecting it for a match.
*
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using unusual
* formatting to disguise some or all of the command, use this option to perform the following transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
* performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
* corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #textTransformation} will return {@link TextTransformation#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #textTransformationAsString}.
*
*
* @return Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
* FieldToMatch before inspecting it for a match.
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using
* unusual formatting to disguise some or all of the command, use this option to perform the following
* transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters.
* HTML_ENTITY_DECODE performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
* corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
* @see TextTransformation
*/
public final TextTransformation textTransformation() {
return TextTransformation.fromValue(textTransformation);
}
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
* bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
* before inspecting it for a match.
*
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using unusual
* formatting to disguise some or all of the command, use this option to perform the following transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
* performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
* corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #textTransformation} will return {@link TextTransformation#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #textTransformationAsString}.
*
*
* @return Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
* FieldToMatch before inspecting it for a match.
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using
* unusual formatting to disguise some or all of the command, use this option to perform the following
* transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters.
* HTML_ENTITY_DECODE performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
* corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
* @see TextTransformation
*/
public final String textTransformationAsString() {
return textTransformation;
}
/**
*
* Within the portion of a web request that you want to search (for example, in the query string, if any), specify
* where you want AWS WAF to search. Valid values include the following:
*
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the location
* doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In
* addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as the value
* of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed by a
* character other than an alphanumeric character or underscore (_), for example, BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a character
* other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded and followed
* by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web request.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #positionalConstraint} will return {@link PositionalConstraint#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #positionalConstraintAsString}.
*
*
* @return Within the portion of a web request that you want to search (for example, in the query string, if any),
* specify where you want AWS WAF to search. Valid values include the following:
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the
* location doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _).
* In addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as the
* value of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed by
* a character other than an alphanumeric character or underscore (_), for example, BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a
* character other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded and
* followed by characters other than alphanumeric characters or underscore (_), for example,
* -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of
* TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web
* request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web request.
* @see PositionalConstraint
*/
public final PositionalConstraint positionalConstraint() {
return PositionalConstraint.fromValue(positionalConstraint);
}
/**
*
* Within the portion of a web request that you want to search (for example, in the query string, if any), specify
* where you want AWS WAF to search. Valid values include the following:
*
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the location
* doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In
* addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as the value
* of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed by a
* character other than an alphanumeric character or underscore (_), for example, BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a character
* other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded and followed
* by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web request.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #positionalConstraint} will return {@link PositionalConstraint#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #positionalConstraintAsString}.
*
*
* @return Within the portion of a web request that you want to search (for example, in the query string, if any),
* specify where you want AWS WAF to search. Valid values include the following:
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the
* location doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _).
* In addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as the
* value of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed by
* a character other than an alphanumeric character or underscore (_), for example, BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a
* character other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded and
* followed by characters other than alphanumeric characters or underscore (_), for example,
* -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of
* TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web
* request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web request.
* @see PositionalConstraint
*/
public final String positionalConstraintAsString() {
return positionalConstraint;
}
@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(fieldToMatch());
hashCode = 31 * hashCode + Objects.hashCode(targetString());
hashCode = 31 * hashCode + Objects.hashCode(textTransformationAsString());
hashCode = 31 * hashCode + Objects.hashCode(positionalConstraintAsString());
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 ByteMatchTuple)) {
return false;
}
ByteMatchTuple other = (ByteMatchTuple) obj;
return Objects.equals(fieldToMatch(), other.fieldToMatch()) && Objects.equals(targetString(), other.targetString())
&& Objects.equals(textTransformationAsString(), other.textTransformationAsString())
&& Objects.equals(positionalConstraintAsString(), other.positionalConstraintAsString());
}
/**
* 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("ByteMatchTuple").add("FieldToMatch", fieldToMatch()).add("TargetString", targetString())
.add("TextTransformation", textTransformationAsString())
.add("PositionalConstraint", positionalConstraintAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "FieldToMatch":
return Optional.ofNullable(clazz.cast(fieldToMatch()));
case "TargetString":
return Optional.ofNullable(clazz.cast(targetString()));
case "TextTransformation":
return Optional.ofNullable(clazz.cast(textTransformationAsString()));
case "PositionalConstraint":
return Optional.ofNullable(clazz.cast(positionalConstraintAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ByteMatchTuple) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For
* more information, see FieldToMatch.
*
*
* @param fieldToMatch
* The part of a web request that you want AWS WAF to search, such as a specified header or a query
* string. For more information, see FieldToMatch.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fieldToMatch(FieldToMatch fieldToMatch);
/**
*
* The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For
* more information, see FieldToMatch.
*
* This is a convenience method that creates an instance of the {@link FieldToMatch.Builder} avoiding the need
* to create one manually via {@link FieldToMatch#builder()}.
*
*
* When the {@link Consumer} completes, {@link FieldToMatch.Builder#build()} is called immediately and its
* result is passed to {@link #fieldToMatch(FieldToMatch)}.
*
* @param fieldToMatch
* a consumer that will call methods on {@link FieldToMatch.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #fieldToMatch(FieldToMatch)
*/
default Builder fieldToMatch(Consumer fieldToMatch) {
return fieldToMatch(FieldToMatch.builder().applyMutation(fieldToMatch).build());
}
/**
*
* The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web
* requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
*
*
* Valid values depend on the values that you specified for FieldToMatch:
*
*
* -
*
* HEADER: The value that you want AWS WAF to search for in the request header that you specified
* in FieldToMatch, for example, the value of the User-Agent or Referer header.
*
*
* -
*
* METHOD: The HTTP method, which indicates the type of operation specified in the request.
* CloudFront supports the following methods: DELETE, GET, HEAD,
* OPTIONS, PATCH, POST, and PUT.
*
*
* -
*
* QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the
* part of a URL that appears after a ? character.
*
*
* -
*
* URI: The value that you want AWS WAF to search for in the part of a URL that identifies a
* resource, for example, /images/daily-ad.jpg.
*
*
* -
*
* BODY: The part of a request that contains any additional data that you want to send to your web
* server as the HTTP request body, such as data from a form. The request body immediately follows the request
* headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for
* inspection. To allow or block requests based on the length of the body, you can create a size constraint set.
* For more information, see CreateSizeConstraintSet.
*
*
* -
*
* SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as
* UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
*
*
* -
*
* ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single
* parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you
* specify in TargetString.
*
*
*
*
* If TargetString includes alphabetic characters A-Z and a-z, note that the value is case
* sensitive.
*
*
* If you're using the AWS WAF API
*
*
* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is
* 50 bytes.
*
*
* For example, suppose the value of Type is HEADER and the value of Data
* is User-Agent. If you want to search the User-Agent header for the value
* BadBot, you base64-encode BadBot using MIME base64-encoding and include the
* resulting value, QmFkQm90, in the value of TargetString.
*
*
* If you're using the AWS CLI or one of the AWS SDKs
*
*
* The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
*
*
* @param targetString
* The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part
* of web requests that you specified in FieldToMatch. The maximum length of the value is 50
* bytes.
*
* Valid values depend on the values that you specified for FieldToMatch:
*
*
* -
*
* HEADER: The value that you want AWS WAF to search for in the request header that you
* specified in FieldToMatch, for example, the value of the User-Agent or
* Referer header.
*
*
* -
*
* METHOD: The HTTP method, which indicates the type of operation specified in the request.
* CloudFront supports the following methods: DELETE, GET, HEAD,
* OPTIONS, PATCH, POST, and PUT.
*
*
* -
*
* QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is
* the part of a URL that appears after a ? character.
*
*
* -
*
* URI: The value that you want AWS WAF to search for in the part of a URL that identifies a
* resource, for example, /images/daily-ad.jpg.
*
*
* -
*
* BODY: The part of a request that contains any additional data that you want to send to
* your web server as the HTTP request body, such as data from a form. The request body immediately
* follows the request headers. Note that only the first 8192 bytes of the request body are
* forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you
* can create a size constraint set. For more information, see CreateSizeConstraintSet.
*
*
* -
*
* SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as
* UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30
* characters.
*
*
* -
*
* ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a
* single parameter, AWS WAF inspects all parameters within the query string for the value or regex
* pattern that you specify in TargetString.
*
*
*
*
* If TargetString includes alphabetic characters A-Z and a-z, note that the value is case
* sensitive.
*
*
* If you're using the AWS WAF API
*
*
* Specify a base64-encoded version of the value. The maximum length of the value before you
* base64-encode it is 50 bytes.
*
*
* For example, suppose the value of Type is HEADER and the value of
* Data is User-Agent. If you want to search the User-Agent header
* for the value BadBot, you base64-encode BadBot using MIME base64-encoding
* and include the resulting value, QmFkQm90, in the value of TargetString.
*
*
* If you're using the AWS CLI or one of the AWS SDKs
*
*
* The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetString(SdkBytes targetString);
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort
* to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
* FieldToMatch before inspecting it for a match.
*
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using unusual
* formatting to disguise some or all of the command, use this option to perform the following transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
* performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
* corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
*
*
* @param textTransformation
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
* FieldToMatch before inspecting it for a match.
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using
* unusual formatting to disguise some or all of the command, use this option to perform the following
* transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters.
* HTML_ENTITY_DECODE performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with
* the corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
* @see TextTransformation
* @return Returns a reference to this object so that method calls can be chained together.
* @see TextTransformation
*/
Builder textTransformation(String textTransformation);
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort
* to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
* FieldToMatch before inspecting it for a match.
*
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using unusual
* formatting to disguise some or all of the command, use this option to perform the following transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
* performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
* corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
*
*
* @param textTransformation
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
* FieldToMatch before inspecting it for a match.
*
* You can only specify a single type of TextTransformation.
*
*
* CMD_LINE
*
*
* When you're concerned that attackers are injecting an operating system command line command and using
* unusual formatting to disguise some or all of the command, use this option to perform the following
* transformations:
*
*
* -
*
* Delete the following characters: \ " ' ^
*
*
* -
*
* Delete spaces before the following characters: / (
*
*
* -
*
* Replace the following characters with a space: , ;
*
*
* -
*
* Replace multiple spaces with one space
*
*
* -
*
* Convert uppercase letters (A-Z) to lowercase (a-z)
*
*
*
*
* COMPRESS_WHITE_SPACE
*
*
* Use this option to replace the following characters with a space character (decimal 32):
*
*
* -
*
* \f, formfeed, decimal 12
*
*
* -
*
* \t, tab, decimal 9
*
*
* -
*
* \n, newline, decimal 10
*
*
* -
*
* \r, carriage return, decimal 13
*
*
* -
*
* \v, vertical tab, decimal 11
*
*
* -
*
* non-breaking space, decimal 160
*
*
*
*
* COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
*
*
* HTML_ENTITY_DECODE
*
*
* Use this option to replace HTML-encoded characters with unencoded characters.
* HTML_ENTITY_DECODE performs the following operations:
*
*
* -
*
* Replaces (ampersand)quot; with "
*
*
* -
*
* Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
*
*
* -
*
* Replaces (ampersand)lt; with a "less than" symbol
*
*
* -
*
* Replaces (ampersand)gt; with >
*
*
* -
*
* Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with
* the corresponding characters
*
*
* -
*
* Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
* corresponding characters
*
*
*
*
* LOWERCASE
*
*
* Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
*
*
* URL_DECODE
*
*
* Use this option to decode a URL-encoded value.
*
*
* NONE
*
*
* Specify NONE if you don't want to perform any text transformations.
* @see TextTransformation
* @return Returns a reference to this object so that method calls can be chained together.
* @see TextTransformation
*/
Builder textTransformation(TextTransformation textTransformation);
/**
*
* Within the portion of a web request that you want to search (for example, in the query string, if any),
* specify where you want AWS WAF to search. Valid values include the following:
*
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the location
* doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In
* addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as the
* value of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed by a
* character other than an alphanumeric character or underscore (_), for example, BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a
* character other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded and
* followed by characters other than alphanumeric characters or underscore (_), for example,
* -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web request.
*
*
* @param positionalConstraint
* Within the portion of a web request that you want to search (for example, in the query string, if
* any), specify where you want AWS WAF to search. Valid values include the following:
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the
* location doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or
* _). In addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as
* the value of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed
* by a character other than an alphanumeric character or underscore (_), for example,
* BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a
* character other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded
* and followed by characters other than alphanumeric characters or underscore (_), for example,
* -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of
* TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web
* request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web
* request.
* @see PositionalConstraint
* @return Returns a reference to this object so that method calls can be chained together.
* @see PositionalConstraint
*/
Builder positionalConstraint(String positionalConstraint);
/**
*
* Within the portion of a web request that you want to search (for example, in the query string, if any),
* specify where you want AWS WAF to search. Valid values include the following:
*
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the location
* doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In
* addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as the
* value of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed by a
* character other than an alphanumeric character or underscore (_), for example, BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a
* character other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded and
* followed by characters other than alphanumeric characters or underscore (_), for example,
* -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web request.
*
*
* @param positionalConstraint
* Within the portion of a web request that you want to search (for example, in the query string, if
* any), specify where you want AWS WAF to search. Valid values include the following:
*
* CONTAINS
*
*
* The specified part of the web request must include the value of TargetString, but the
* location doesn't matter.
*
*
* CONTAINS_WORD
*
*
* The specified part of the web request must include the value of TargetString, and
* TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or
* _). In addition, TargetString must be a word, which means one of the following:
*
*
* -
*
* TargetString exactly matches the value of the specified part of the web request, such as
* the value of a header.
*
*
* -
*
* TargetString is at the beginning of the specified part of the web request and is followed
* by a character other than an alphanumeric character or underscore (_), for example,
* BadBot;.
*
*
* -
*
* TargetString is at the end of the specified part of the web request and is preceded by a
* character other than an alphanumeric character or underscore (_), for example, ;BadBot.
*
*
* -
*
* TargetString is in the middle of the specified part of the web request and is preceded
* and followed by characters other than alphanumeric characters or underscore (_), for example,
* -BadBot;.
*
*
*
*
* EXACTLY
*
*
* The value of the specified part of the web request must exactly match the value of
* TargetString.
*
*
* STARTS_WITH
*
*
* The value of TargetString must appear at the beginning of the specified part of the web
* request.
*
*
* ENDS_WITH
*
*
* The value of TargetString must appear at the end of the specified part of the web
* request.
* @see PositionalConstraint
* @return Returns a reference to this object so that method calls can be chained together.
* @see PositionalConstraint
*/
Builder positionalConstraint(PositionalConstraint positionalConstraint);
}
static final class BuilderImpl implements Builder {
private FieldToMatch fieldToMatch;
private SdkBytes targetString;
private String textTransformation;
private String positionalConstraint;
private BuilderImpl() {
}
private BuilderImpl(ByteMatchTuple model) {
fieldToMatch(model.fieldToMatch);
targetString(model.targetString);
textTransformation(model.textTransformation);
positionalConstraint(model.positionalConstraint);
}
public final FieldToMatch.Builder getFieldToMatch() {
return fieldToMatch != null ? fieldToMatch.toBuilder() : null;
}
public final void setFieldToMatch(FieldToMatch.BuilderImpl fieldToMatch) {
this.fieldToMatch = fieldToMatch != null ? fieldToMatch.build() : null;
}
@Override
public final Builder fieldToMatch(FieldToMatch fieldToMatch) {
this.fieldToMatch = fieldToMatch;
return this;
}
public final ByteBuffer getTargetString() {
return targetString == null ? null : targetString.asByteBuffer();
}
public final void setTargetString(ByteBuffer targetString) {
targetString(targetString == null ? null : SdkBytes.fromByteBuffer(targetString));
}
@Override
public final Builder targetString(SdkBytes targetString) {
this.targetString = targetString;
return this;
}
public final String getTextTransformation() {
return textTransformation;
}
public final void setTextTransformation(String textTransformation) {
this.textTransformation = textTransformation;
}
@Override
public final Builder textTransformation(String textTransformation) {
this.textTransformation = textTransformation;
return this;
}
@Override
public final Builder textTransformation(TextTransformation textTransformation) {
this.textTransformation(textTransformation == null ? null : textTransformation.toString());
return this;
}
public final String getPositionalConstraint() {
return positionalConstraint;
}
public final void setPositionalConstraint(String positionalConstraint) {
this.positionalConstraint = positionalConstraint;
}
@Override
public final Builder positionalConstraint(String positionalConstraint) {
this.positionalConstraint = positionalConstraint;
return this;
}
@Override
public final Builder positionalConstraint(PositionalConstraint positionalConstraint) {
this.positionalConstraint(positionalConstraint == null ? null : positionalConstraint.toString());
return this;
}
@Override
public ByteMatchTuple build() {
return new ByteMatchTuple(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}