com.amazonaws.services.wafv2.model.CustomRequestHandling Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling
* for WAF to use when the rule action doesn't block the request. For example, CaptchaAction for requests
* with valid t okens, and AllowAction.
*
*
* For information about customizing web requests and responses, see Customizing web
* requests and responses in WAF in the WAF Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CustomRequestHandling implements Serializable, Cloneable, StructuredPojo {
/**
*
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*/
private java.util.List insertHeaders;
/**
*
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*
* @return The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF
* Developer Guide.
*/
public java.util.List getInsertHeaders() {
return insertHeaders;
}
/**
*
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*
* @param insertHeaders
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF
* Developer Guide.
*/
public void setInsertHeaders(java.util.Collection insertHeaders) {
if (insertHeaders == null) {
this.insertHeaders = null;
return;
}
this.insertHeaders = new java.util.ArrayList(insertHeaders);
}
/**
*
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInsertHeaders(java.util.Collection)} or {@link #withInsertHeaders(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param insertHeaders
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomRequestHandling withInsertHeaders(CustomHTTPHeader... insertHeaders) {
if (this.insertHeaders == null) {
setInsertHeaders(new java.util.ArrayList(insertHeaders.length));
}
for (CustomHTTPHeader ele : insertHeaders) {
this.insertHeaders.add(ele);
}
return this;
}
/**
*
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer
* Guide.
*
*
* @param insertHeaders
* The HTTP headers to insert into the request. Duplicate header names are not allowed.
*
* For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomRequestHandling withInsertHeaders(java.util.Collection insertHeaders) {
setInsertHeaders(insertHeaders);
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 (getInsertHeaders() != null)
sb.append("InsertHeaders: ").append(getInsertHeaders());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CustomRequestHandling == false)
return false;
CustomRequestHandling other = (CustomRequestHandling) obj;
if (other.getInsertHeaders() == null ^ this.getInsertHeaders() == null)
return false;
if (other.getInsertHeaders() != null && other.getInsertHeaders().equals(this.getInsertHeaders()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInsertHeaders() == null) ? 0 : getInsertHeaders().hashCode());
return hashCode;
}
@Override
public CustomRequestHandling clone() {
try {
return (CustomRequestHandling) 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.CustomRequestHandlingMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}