Class ByteMatchSet

  • All Implemented Interfaces:
    Serializable, Cloneable

    public class ByteMatchSet
    extends Object
    implements Serializable, Cloneable

    In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

    A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

    See Also:
    Serialized Form
    • Constructor Detail

      • ByteMatchSet

        public ByteMatchSet()
    • Method Detail

      • setName

        public void setName​(String name)

        A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

        Parameters:
        name - A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
      • getName

        public String getName()

        A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

        Returns:
        A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
      • withName

        public ByteMatchSet withName​(String name)

        A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

        Parameters:
        name - A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getByteMatchTuples

        public List<ByteMatchTuple> getByteMatchTuples()

        Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

        Returns:
        Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
      • setByteMatchTuples

        public void setByteMatchTuples​(Collection<ByteMatchTuple> byteMatchTuples)

        Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

        Parameters:
        byteMatchTuples - Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
      • withByteMatchTuples

        public ByteMatchSet withByteMatchTuples​(ByteMatchTuple... byteMatchTuples)

        Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

        NOTE: This method appends the values to the existing list (if any). Use setByteMatchTuples(java.util.Collection) or withByteMatchTuples(java.util.Collection) if you want to override the existing values.

        Parameters:
        byteMatchTuples - Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withByteMatchTuples

        public ByteMatchSet withByteMatchTuples​(Collection<ByteMatchTuple> byteMatchTuples)

        Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

        Parameters:
        byteMatchTuples - Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object