com.amazonaws.services.waf.model.FieldToMatch Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2010-2016 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.waf.model;
import java.io.Serializable;
/**
*
* Specifies where in a web request to look for TargetString.
*
*/
public class FieldToMatch implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String type;
/**
*
* 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.
*
*/
private String data;
/**
*
* 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.
*
*
* @param 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.
* 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.
*
*
* @return 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.
* 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.
*
*
* @param 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.
* 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.
*
*
* @param 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.
* 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.
*
*
* @param 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.
* 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.
*
*
* @param 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.
*/
public void setData(String data) {
this.data = 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.
*
*
* @return 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.
*/
public String getData() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public FieldToMatch withData(String data) {
setData(data);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getType() != null)
sb.append("Type: " + getType() + ",");
if (getData() != null)
sb.append("Data: " + getData());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FieldToMatch == false)
return false;
FieldToMatch other = (FieldToMatch) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null
&& other.getType().equals(this.getType()) == false)
return false;
if (other.getData() == null ^ this.getData() == null)
return false;
if (other.getData() != null
&& other.getData().equals(this.getData()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode
+ ((getData() == null) ? 0 : getData().hashCode());
return hashCode;
}
@Override
public FieldToMatch clone() {
try {
return (FieldToMatch) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}