/* * Copyright 2018-2023 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 com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement * provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes * to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer * guide, this is called a string match statement. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ByteMatchStatement implements Serializable, Cloneable, StructuredPojo { /** *

* A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate * for inspection in FieldToMatch. The maximum length of the value is 200 bytes. *

*

* Valid values depend on the component that you specify for inspection in FieldToMatch: *

* *

* If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. *

*

* If you're using the WAF API *

*

* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 * 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 SearchString. *

*

* If you're using the CLI or one of the Amazon Web Services SDKs *

*

* The value that you want WAF to search for. The SDK automatically base64 encodes the value. *

*/ private java.nio.ByteBuffer searchString; /** *

* The part of the web request that you want WAF to inspect. *

*/ private FieldToMatch fieldToMatch; /** *

* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to * bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, * to transform request components before using them as custom aggregation keys. If you specify one or more * transformations to apply, WAF performs all transformations on the specified content, starting from the lowest * priority setting, and then uses the component contents. *

*/ private java.util.List textTransformations; /** *

* The area within the portion of the web request that you want WAF to search for SearchString. Valid * values include the following: *

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the location * doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In * addition, SearchString must be a word, which means that both of the following are true: *

* *

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. *

*/ private String positionalConstraint; /** *

* A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate * for inspection in FieldToMatch. The maximum length of the value is 200 bytes. *

*

* Valid values depend on the component that you specify for inspection in FieldToMatch: *

* *

* If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. *

*

* If you're using the WAF API *

*

* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 * 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 SearchString. *

*

* If you're using the CLI or one of the Amazon Web Services SDKs *

*

* The value that you want WAF to search for. The SDK automatically base64 encodes the value. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

*

* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will * be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or * ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future * major version of the SDK. *

* * @param searchString * A string value that you want WAF to search for. WAF searches only in the part of web requests that you * designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.

*

* Valid values depend on the component that you specify for inspection in FieldToMatch: *

* *

* If SearchString includes alphabetic characters A-Z and a-z, note that the value is case * sensitive. *

*

* If you're using the WAF API *

*

* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it * is 200 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 SearchString. *

*

* If you're using the CLI or one of the Amazon Web Services SDKs *

*

* The value that you want WAF to search for. The SDK automatically base64 encodes the value. */ public void setSearchString(java.nio.ByteBuffer searchString) { this.searchString = searchString; } /** *

* A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate * for inspection in FieldToMatch. The maximum length of the value is 200 bytes. *

*

* Valid values depend on the component that you specify for inspection in FieldToMatch: *

* *

* If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. *

*

* If you're using the WAF API *

*

* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 * 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 SearchString. *

*

* If you're using the CLI or one of the Amazon Web Services SDKs *

*

* The value that you want WAF to search for. The SDK automatically base64 encodes the value. *

*

* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend * using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent * {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. * Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the * {@code position}. *

* * @return A string value that you want WAF to search for. WAF searches only in the part of web requests that you * designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.

*

* Valid values depend on the component that you specify for inspection in FieldToMatch: *

* *

* If SearchString includes alphabetic characters A-Z and a-z, note that the value is case * sensitive. *

*

* If you're using the WAF API *

*

* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode * it is 200 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 SearchString. *

*

* If you're using the CLI or one of the Amazon Web Services SDKs *

*

* The value that you want WAF to search for. The SDK automatically base64 encodes the value. */ public java.nio.ByteBuffer getSearchString() { return this.searchString; } /** *

* A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate * for inspection in FieldToMatch. The maximum length of the value is 200 bytes. *

*

* Valid values depend on the component that you specify for inspection in FieldToMatch: *

* *

* If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. *

*

* If you're using the WAF API *

*

* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 * 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 SearchString. *

*

* If you're using the CLI or one of the Amazon Web Services SDKs *

*

* The value that you want WAF to search for. The SDK automatically base64 encodes the value. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

*

* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will * be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or * ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future * major version of the SDK. *

* * @param searchString * A string value that you want WAF to search for. WAF searches only in the part of web requests that you * designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.

*

* Valid values depend on the component that you specify for inspection in FieldToMatch: *

* *

* If SearchString includes alphabetic characters A-Z and a-z, note that the value is case * sensitive. *

*

* If you're using the WAF API *

*

* Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it * is 200 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 SearchString. *

*

* If you're using the CLI or one of the Amazon Web Services SDKs *

*

* The value that you want 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. */ public ByteMatchStatement withSearchString(java.nio.ByteBuffer searchString) { setSearchString(searchString); return this; } /** *

* The part of the web request that you want WAF to inspect. *

* * @param fieldToMatch * The part of the web request that you want WAF to inspect. */ public void setFieldToMatch(FieldToMatch fieldToMatch) { this.fieldToMatch = fieldToMatch; } /** *

* The part of the web request that you want WAF to inspect. *

* * @return The part of the web request that you want WAF to inspect. */ public FieldToMatch getFieldToMatch() { return this.fieldToMatch; } /** *

* The part of the web request that you want WAF to inspect. *

* * @param fieldToMatch * The part of the web request that you want WAF to inspect. * @return Returns a reference to this object so that method calls can be chained together. */ public ByteMatchStatement withFieldToMatch(FieldToMatch fieldToMatch) { setFieldToMatch(fieldToMatch); return this; } /** *

* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to * bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, * to transform request components before using them as custom aggregation keys. If you specify one or more * transformations to apply, WAF performs all transformations on the specified content, starting from the lowest * priority setting, and then uses the component contents. *

* * @return Text transformations eliminate some of the unusual formatting that attackers use in web requests in an * effort to bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule * statements, to transform request components before using them as custom aggregation keys. If you specify * one or more transformations to apply, WAF performs all transformations on the specified content, starting * from the lowest priority setting, and then uses the component contents. */ public java.util.List getTextTransformations() { return textTransformations; } /** *

* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to * bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, * to transform request components before using them as custom aggregation keys. If you specify one or more * transformations to apply, WAF performs all transformations on the specified content, starting from the lowest * priority setting, and then uses the component contents. *

* * @param textTransformations * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an * effort to bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule * statements, to transform request components before using them as custom aggregation keys. If you specify * one or more transformations to apply, WAF performs all transformations on the specified content, starting * from the lowest priority setting, and then uses the component contents. */ public void setTextTransformations(java.util.Collection textTransformations) { if (textTransformations == null) { this.textTransformations = null; return; } this.textTransformations = new java.util.ArrayList(textTransformations); } /** *

* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to * bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, * to transform request components before using them as custom aggregation keys. If you specify one or more * transformations to apply, WAF performs all transformations on the specified content, starting from the lowest * priority setting, and then uses the component contents. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTextTransformations(java.util.Collection)} or {@link #withTextTransformations(java.util.Collection)} * if you want to override the existing values. *

* * @param textTransformations * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an * effort to bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule * statements, to transform request components before using them as custom aggregation keys. If you specify * one or more transformations to apply, WAF performs all transformations on the specified content, starting * from the lowest priority setting, and then uses the component contents. * @return Returns a reference to this object so that method calls can be chained together. */ public ByteMatchStatement withTextTransformations(TextTransformation... textTransformations) { if (this.textTransformations == null) { setTextTransformations(new java.util.ArrayList(textTransformations.length)); } for (TextTransformation ele : textTransformations) { this.textTransformations.add(ele); } return this; } /** *

* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to * bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, * to transform request components before using them as custom aggregation keys. If you specify one or more * transformations to apply, WAF performs all transformations on the specified content, starting from the lowest * priority setting, and then uses the component contents. *

* * @param textTransformations * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an * effort to bypass detection. Text transformations are used in rule match statements, to transform the * FieldToMatch request component before inspecting it, and they're used in rate-based rule * statements, to transform request components before using them as custom aggregation keys. If you specify * one or more transformations to apply, WAF performs all transformations on the specified content, starting * from the lowest priority setting, and then uses the component contents. * @return Returns a reference to this object so that method calls can be chained together. */ public ByteMatchStatement withTextTransformations(java.util.Collection textTransformations) { setTextTransformations(textTransformations); return this; } /** *

* The area within the portion of the web request that you want WAF to search for SearchString. Valid * values include the following: *

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the location * doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In * addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by a * character other than an alphanumeric character or underscore (_). Examples include the value of a header and * ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a character * other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. *

* * @param positionalConstraint * The area within the portion of the web request that you want WAF to search for SearchString. * Valid values include the following:

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the * location doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). * In addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by a * character other than an alphanumeric character or underscore (_). Examples include the value of a header * and ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a * character other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of * SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web * request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. * @see PositionalConstraint */ public void setPositionalConstraint(String positionalConstraint) { this.positionalConstraint = positionalConstraint; } /** *

* The area within the portion of the web request that you want WAF to search for SearchString. Valid * values include the following: *

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the location * doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In * addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by a * character other than an alphanumeric character or underscore (_). Examples include the value of a header and * ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a character * other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. *

* * @return The area within the portion of the web request that you want WAF to search for SearchString. * Valid values include the following:

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the * location doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). * In addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by * a character other than an alphanumeric character or underscore (_). Examples include the value of a * header and ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a * character other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of * SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web * request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. * @see PositionalConstraint */ public String getPositionalConstraint() { return this.positionalConstraint; } /** *

* The area within the portion of the web request that you want WAF to search for SearchString. Valid * values include the following: *

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the location * doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In * addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by a * character other than an alphanumeric character or underscore (_). Examples include the value of a header and * ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a character * other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. *

* * @param positionalConstraint * The area within the portion of the web request that you want WAF to search for SearchString. * Valid values include the following:

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the * location doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). * In addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by a * character other than an alphanumeric character or underscore (_). Examples include the value of a header * and ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a * character other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of * SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web * request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. * @return Returns a reference to this object so that method calls can be chained together. * @see PositionalConstraint */ public ByteMatchStatement withPositionalConstraint(String positionalConstraint) { setPositionalConstraint(positionalConstraint); return this; } /** *

* The area within the portion of the web request that you want WAF to search for SearchString. Valid * values include the following: *

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the location * doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In * addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by a * character other than an alphanumeric character or underscore (_). Examples include the value of a header and * ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a character * other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. *

* * @param positionalConstraint * The area within the portion of the web request that you want WAF to search for SearchString. * Valid values include the following:

*

* CONTAINS *

*

* The specified part of the web request must include the value of SearchString, but the * location doesn't matter. *

*

* CONTAINS_WORD *

*

* The specified part of the web request must include the value of SearchString, and * SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). * In addition, SearchString must be a word, which means that both of the following are true: *

*
    *
  • *

    * SearchString is at the beginning of the specified part of the web request or is preceded by a * character other than an alphanumeric character or underscore (_). Examples include the value of a header * and ;BadBot. *

    *
    • *
  • *

    * SearchString is at the end of the specified part of the web request or is followed by a * character other than an alphanumeric character or underscore (_), for example, BadBot; and * -BadBot;. *

    *
    • *
*

* EXACTLY *

*

* The value of the specified part of the web request must exactly match the value of * SearchString. *

*

* STARTS_WITH *

*

* The value of SearchString must appear at the beginning of the specified part of the web * request. *

*

* ENDS_WITH *

*

* The value of SearchString must appear at the end of the specified part of the web request. * @return Returns a reference to this object so that method calls can be chained together. * @see PositionalConstraint */ public ByteMatchStatement withPositionalConstraint(PositionalConstraint positionalConstraint) { this.positionalConstraint = positionalConstraint.toString(); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getSearchString() != null) sb.append("SearchString: ").append(getSearchString()).append(","); if (getFieldToMatch() != null) sb.append("FieldToMatch: ").append(getFieldToMatch()).append(","); if (getTextTransformations() != null) sb.append("TextTransformations: ").append(getTextTransformations()).append(","); if (getPositionalConstraint() != null) sb.append("PositionalConstraint: ").append(getPositionalConstraint()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ByteMatchStatement == false) return false; ByteMatchStatement other = (ByteMatchStatement) obj; if (other.getSearchString() == null ^ this.getSearchString() == null) return false; if (other.getSearchString() != null && other.getSearchString().equals(this.getSearchString()) == false) return false; if (other.getFieldToMatch() == null ^ this.getFieldToMatch() == null) return false; if (other.getFieldToMatch() != null && other.getFieldToMatch().equals(this.getFieldToMatch()) == false) return false; if (other.getTextTransformations() == null ^ this.getTextTransformations() == null) return false; if (other.getTextTransformations() != null && other.getTextTransformations().equals(this.getTextTransformations()) == false) return false; if (other.getPositionalConstraint() == null ^ this.getPositionalConstraint() == null) return false; if (other.getPositionalConstraint() != null && other.getPositionalConstraint().equals(this.getPositionalConstraint()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getSearchString() == null) ? 0 : getSearchString().hashCode()); hashCode = prime * hashCode + ((getFieldToMatch() == null) ? 0 : getFieldToMatch().hashCode()); hashCode = prime * hashCode + ((getTextTransformations() == null) ? 0 : getTextTransformations().hashCode()); hashCode = prime * hashCode + ((getPositionalConstraint() == null) ? 0 : getPositionalConstraint().hashCode()); return hashCode; } @Override public ByteMatchStatement clone() { try { return (ByteMatchStatement) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.wafv2.model.transform.ByteMatchStatementMarshaller.getInstance().marshall(this, protocolMarshaller); } }