Class FieldToMatch

java.lang.Object
com.amazonaws.services.waf.model.FieldToMatch
All Implemented Interfaces:
Serializable, Cloneable

public class FieldToMatch extends Object implements Serializable, Cloneable

Specifies where in a web request to look for TargetString.

See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    boolean
     
    When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer.
    The part of the web request that you want AWS WAF to search for a specified string.
    int
     
    void
    When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer.
    void
    The part of the web request that you want AWS WAF to search for a specified string.
    void
    The part of the web request that you want AWS WAF to search for a specified string.
    Returns a string representation of this object; useful for testing and debugging.
    When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer.
    The part of the web request that you want AWS WAF to search for a specified string.
    The part of the web request that you want AWS WAF to search for a specified string.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • FieldToMatch

      public FieldToMatch()
  • Method Details

    • setType

      public void setType(String type)

      The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      Parameters:
      type - The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      See Also:
    • getType

      public String getType()

      The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      Returns:
      The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      See Also:
    • withType

      public FieldToMatch withType(String type)

      The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      Parameters:
      type - The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setType

      public void setType(MatchFieldType type)

      The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      Parameters:
      type - The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      See Also:
    • withType

      public FieldToMatch withType(MatchFieldType type)

      The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      Parameters:
      type - The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

      • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
      • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
      • URI: The part of a web request 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setData

      public void setData(String data)

      When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

      The name of the header is not case sensitive.

      Parameters:
      data - When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

      The name of the header is not case sensitive.

    • getData

      public String getData()

      When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

      The name of the header is not case sensitive.

      Returns:
      When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

      The name of the header is not case sensitive.

    • withData

      public FieldToMatch withData(String data)

      When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

      The name of the header is not case sensitive.

      Parameters:
      data - When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

      The name of the header is not case sensitive.

      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public FieldToMatch clone()
      Overrides:
      clone in class Object