com.oracle.bmc.waas.model.WafConfigDetails Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-shaded-full Show documentation
Show all versions of oci-java-sdk-shaded-full Show documentation
This project contains the SDK distribution used for Oracle Cloud Infrastructure, and all the dependencies that can be shaded. It also has Maven dependencies that cannot be shaded. Therefore, use this module to depend on the shaded distribution via Maven -- it will shade everything that can be shaded, and automatically pull in the other dependencies.
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.waas.model;
/**
* The Web Application Firewall configuration for the WAAS policy creation.
* Note: Objects should always be created or deserialized using the {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #equals(Object)} methods are implemented to take the explicitly set
* fields into account. The constructor, on the other hand, does not take the explicitly set fields
* into account (since the constructor cannot distinguish explicit {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20181116")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = WafConfigDetails.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class WafConfigDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"accessRules",
"addressRateLimiting",
"captchas",
"deviceFingerprintChallenge",
"humanInteractionChallenge",
"jsChallenge",
"origin",
"cachingRules",
"customProtectionRules",
"originGroups",
"protectionSettings",
"whitelists"
})
public WafConfigDetails(
java.util.List accessRules,
AddressRateLimiting addressRateLimiting,
java.util.List captchas,
DeviceFingerprintChallenge deviceFingerprintChallenge,
HumanInteractionChallenge humanInteractionChallenge,
JsChallenge jsChallenge,
String origin,
java.util.List cachingRules,
java.util.List customProtectionRules,
java.util.List originGroups,
ProtectionSettings protectionSettings,
java.util.List whitelists) {
super();
this.accessRules = accessRules;
this.addressRateLimiting = addressRateLimiting;
this.captchas = captchas;
this.deviceFingerprintChallenge = deviceFingerprintChallenge;
this.humanInteractionChallenge = humanInteractionChallenge;
this.jsChallenge = jsChallenge;
this.origin = origin;
this.cachingRules = cachingRules;
this.customProtectionRules = customProtectionRules;
this.originGroups = originGroups;
this.protectionSettings = protectionSettings;
this.whitelists = whitelists;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/**
* The access rules applied to the Web Application Firewall. Access rules allow custom
* content access policies to be defined and {@code ALLOW}, {@code DETECT}, or {@code BLOCK}
* actions to be taken on a request when specified criteria are met.
*/
@com.fasterxml.jackson.annotation.JsonProperty("accessRules")
private java.util.List accessRules;
/**
* The access rules applied to the Web Application Firewall. Access rules allow custom
* content access policies to be defined and {@code ALLOW}, {@code DETECT}, or {@code BLOCK}
* actions to be taken on a request when specified criteria are met.
*
* @param accessRules the value to set
* @return this builder
*/
public Builder accessRules(java.util.List accessRules) {
this.accessRules = accessRules;
this.__explicitlySet__.add("accessRules");
return this;
}
/** The settings used to limit the number of requests from an IP address. */
@com.fasterxml.jackson.annotation.JsonProperty("addressRateLimiting")
private AddressRateLimiting addressRateLimiting;
/**
* The settings used to limit the number of requests from an IP address.
*
* @param addressRateLimiting the value to set
* @return this builder
*/
public Builder addressRateLimiting(AddressRateLimiting addressRateLimiting) {
this.addressRateLimiting = addressRateLimiting;
this.__explicitlySet__.add("addressRateLimiting");
return this;
}
/**
* A list of CAPTCHA challenge settings. CAPTCHAs challenge requests to ensure a human is
* attempting to reach the specified URL and not a bot.
*/
@com.fasterxml.jackson.annotation.JsonProperty("captchas")
private java.util.List captchas;
/**
* A list of CAPTCHA challenge settings. CAPTCHAs challenge requests to ensure a human is
* attempting to reach the specified URL and not a bot.
*
* @param captchas the value to set
* @return this builder
*/
public Builder captchas(java.util.List captchas) {
this.captchas = captchas;
this.__explicitlySet__.add("captchas");
return this;
}
/**
* The device fingerprint challenge settings. Blocks bots based on unique device fingerprint
* information.
*/
@com.fasterxml.jackson.annotation.JsonProperty("deviceFingerprintChallenge")
private DeviceFingerprintChallenge deviceFingerprintChallenge;
/**
* The device fingerprint challenge settings. Blocks bots based on unique device fingerprint
* information.
*
* @param deviceFingerprintChallenge the value to set
* @return this builder
*/
public Builder deviceFingerprintChallenge(
DeviceFingerprintChallenge deviceFingerprintChallenge) {
this.deviceFingerprintChallenge = deviceFingerprintChallenge;
this.__explicitlySet__.add("deviceFingerprintChallenge");
return this;
}
/**
* The human interaction challenge settings. Detects natural human interactions such as
* mouse movements, time on site, and page scrolling to identify bots.
*/
@com.fasterxml.jackson.annotation.JsonProperty("humanInteractionChallenge")
private HumanInteractionChallenge humanInteractionChallenge;
/**
* The human interaction challenge settings. Detects natural human interactions such as
* mouse movements, time on site, and page scrolling to identify bots.
*
* @param humanInteractionChallenge the value to set
* @return this builder
*/
public Builder humanInteractionChallenge(
HumanInteractionChallenge humanInteractionChallenge) {
this.humanInteractionChallenge = humanInteractionChallenge;
this.__explicitlySet__.add("humanInteractionChallenge");
return this;
}
/**
* The JavaScript challenge settings. Blocks bots by challenging requests from browsers that
* have no JavaScript support.
*/
@com.fasterxml.jackson.annotation.JsonProperty("jsChallenge")
private JsChallenge jsChallenge;
/**
* The JavaScript challenge settings. Blocks bots by challenging requests from browsers that
* have no JavaScript support.
*
* @param jsChallenge the value to set
* @return this builder
*/
public Builder jsChallenge(JsChallenge jsChallenge) {
this.jsChallenge = jsChallenge;
this.__explicitlySet__.add("jsChallenge");
return this;
}
/**
* The key in the map of origins referencing the origin used for the Web Application
* Firewall. The origin must already be included in {@code Origins}. Required when creating
* the {@code WafConfig} resource, but is not required upon updating the configuration.
*/
@com.fasterxml.jackson.annotation.JsonProperty("origin")
private String origin;
/**
* The key in the map of origins referencing the origin used for the Web Application
* Firewall. The origin must already be included in {@code Origins}. Required when creating
* the {@code WafConfig} resource, but is not required upon updating the configuration.
*
* @param origin the value to set
* @return this builder
*/
public Builder origin(String origin) {
this.origin = origin;
this.__explicitlySet__.add("origin");
return this;
}
/** A list of caching rules applied to the web application. */
@com.fasterxml.jackson.annotation.JsonProperty("cachingRules")
private java.util.List cachingRules;
/**
* A list of caching rules applied to the web application.
*
* @param cachingRules the value to set
* @return this builder
*/
public Builder cachingRules(java.util.List cachingRules) {
this.cachingRules = cachingRules;
this.__explicitlySet__.add("cachingRules");
return this;
}
/** A list of the custom protection rule OCIDs and their actions. */
@com.fasterxml.jackson.annotation.JsonProperty("customProtectionRules")
private java.util.List customProtectionRules;
/**
* A list of the custom protection rule OCIDs and their actions.
*
* @param customProtectionRules the value to set
* @return this builder
*/
public Builder customProtectionRules(
java.util.List customProtectionRules) {
this.customProtectionRules = customProtectionRules;
this.__explicitlySet__.add("customProtectionRules");
return this;
}
/**
* The map of origin groups and their keys used to associate origins to the {@code
* wafConfig}. Origin groups allow you to apply weights to groups of origins for load
* balancing purposes. Origins with higher weights will receive larger proportions of client
* requests. To add additional origins to your WAAS policy, update the {@code origins} field
* of a {@code UpdateWaasPolicy} request.
*/
@com.fasterxml.jackson.annotation.JsonProperty("originGroups")
private java.util.List originGroups;
/**
* The map of origin groups and their keys used to associate origins to the {@code
* wafConfig}. Origin groups allow you to apply weights to groups of origins for load
* balancing purposes. Origins with higher weights will receive larger proportions of client
* requests. To add additional origins to your WAAS policy, update the {@code origins} field
* of a {@code UpdateWaasPolicy} request.
*
* @param originGroups the value to set
* @return this builder
*/
public Builder originGroups(java.util.List originGroups) {
this.originGroups = originGroups;
this.__explicitlySet__.add("originGroups");
return this;
}
/** The settings applied to protection rules. */
@com.fasterxml.jackson.annotation.JsonProperty("protectionSettings")
private ProtectionSettings protectionSettings;
/**
* The settings applied to protection rules.
*
* @param protectionSettings the value to set
* @return this builder
*/
public Builder protectionSettings(ProtectionSettings protectionSettings) {
this.protectionSettings = protectionSettings;
this.__explicitlySet__.add("protectionSettings");
return this;
}
/** A list of IP addresses that bypass the Web Application Firewall. */
@com.fasterxml.jackson.annotation.JsonProperty("whitelists")
private java.util.List whitelists;
/**
* A list of IP addresses that bypass the Web Application Firewall.
*
* @param whitelists the value to set
* @return this builder
*/
public Builder whitelists(java.util.List whitelists) {
this.whitelists = whitelists;
this.__explicitlySet__.add("whitelists");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public WafConfigDetails build() {
WafConfigDetails model =
new WafConfigDetails(
this.accessRules,
this.addressRateLimiting,
this.captchas,
this.deviceFingerprintChallenge,
this.humanInteractionChallenge,
this.jsChallenge,
this.origin,
this.cachingRules,
this.customProtectionRules,
this.originGroups,
this.protectionSettings,
this.whitelists);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(WafConfigDetails model) {
if (model.wasPropertyExplicitlySet("accessRules")) {
this.accessRules(model.getAccessRules());
}
if (model.wasPropertyExplicitlySet("addressRateLimiting")) {
this.addressRateLimiting(model.getAddressRateLimiting());
}
if (model.wasPropertyExplicitlySet("captchas")) {
this.captchas(model.getCaptchas());
}
if (model.wasPropertyExplicitlySet("deviceFingerprintChallenge")) {
this.deviceFingerprintChallenge(model.getDeviceFingerprintChallenge());
}
if (model.wasPropertyExplicitlySet("humanInteractionChallenge")) {
this.humanInteractionChallenge(model.getHumanInteractionChallenge());
}
if (model.wasPropertyExplicitlySet("jsChallenge")) {
this.jsChallenge(model.getJsChallenge());
}
if (model.wasPropertyExplicitlySet("origin")) {
this.origin(model.getOrigin());
}
if (model.wasPropertyExplicitlySet("cachingRules")) {
this.cachingRules(model.getCachingRules());
}
if (model.wasPropertyExplicitlySet("customProtectionRules")) {
this.customProtectionRules(model.getCustomProtectionRules());
}
if (model.wasPropertyExplicitlySet("originGroups")) {
this.originGroups(model.getOriginGroups());
}
if (model.wasPropertyExplicitlySet("protectionSettings")) {
this.protectionSettings(model.getProtectionSettings());
}
if (model.wasPropertyExplicitlySet("whitelists")) {
this.whitelists(model.getWhitelists());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/**
* The access rules applied to the Web Application Firewall. Access rules allow custom content
* access policies to be defined and {@code ALLOW}, {@code DETECT}, or {@code BLOCK} actions to
* be taken on a request when specified criteria are met.
*/
@com.fasterxml.jackson.annotation.JsonProperty("accessRules")
private final java.util.List accessRules;
/**
* The access rules applied to the Web Application Firewall. Access rules allow custom content
* access policies to be defined and {@code ALLOW}, {@code DETECT}, or {@code BLOCK} actions to
* be taken on a request when specified criteria are met.
*
* @return the value
*/
public java.util.List getAccessRules() {
return accessRules;
}
/** The settings used to limit the number of requests from an IP address. */
@com.fasterxml.jackson.annotation.JsonProperty("addressRateLimiting")
private final AddressRateLimiting addressRateLimiting;
/**
* The settings used to limit the number of requests from an IP address.
*
* @return the value
*/
public AddressRateLimiting getAddressRateLimiting() {
return addressRateLimiting;
}
/**
* A list of CAPTCHA challenge settings. CAPTCHAs challenge requests to ensure a human is
* attempting to reach the specified URL and not a bot.
*/
@com.fasterxml.jackson.annotation.JsonProperty("captchas")
private final java.util.List captchas;
/**
* A list of CAPTCHA challenge settings. CAPTCHAs challenge requests to ensure a human is
* attempting to reach the specified URL and not a bot.
*
* @return the value
*/
public java.util.List getCaptchas() {
return captchas;
}
/**
* The device fingerprint challenge settings. Blocks bots based on unique device fingerprint
* information.
*/
@com.fasterxml.jackson.annotation.JsonProperty("deviceFingerprintChallenge")
private final DeviceFingerprintChallenge deviceFingerprintChallenge;
/**
* The device fingerprint challenge settings. Blocks bots based on unique device fingerprint
* information.
*
* @return the value
*/
public DeviceFingerprintChallenge getDeviceFingerprintChallenge() {
return deviceFingerprintChallenge;
}
/**
* The human interaction challenge settings. Detects natural human interactions such as mouse
* movements, time on site, and page scrolling to identify bots.
*/
@com.fasterxml.jackson.annotation.JsonProperty("humanInteractionChallenge")
private final HumanInteractionChallenge humanInteractionChallenge;
/**
* The human interaction challenge settings. Detects natural human interactions such as mouse
* movements, time on site, and page scrolling to identify bots.
*
* @return the value
*/
public HumanInteractionChallenge getHumanInteractionChallenge() {
return humanInteractionChallenge;
}
/**
* The JavaScript challenge settings. Blocks bots by challenging requests from browsers that
* have no JavaScript support.
*/
@com.fasterxml.jackson.annotation.JsonProperty("jsChallenge")
private final JsChallenge jsChallenge;
/**
* The JavaScript challenge settings. Blocks bots by challenging requests from browsers that
* have no JavaScript support.
*
* @return the value
*/
public JsChallenge getJsChallenge() {
return jsChallenge;
}
/**
* The key in the map of origins referencing the origin used for the Web Application Firewall.
* The origin must already be included in {@code Origins}. Required when creating the {@code
* WafConfig} resource, but is not required upon updating the configuration.
*/
@com.fasterxml.jackson.annotation.JsonProperty("origin")
private final String origin;
/**
* The key in the map of origins referencing the origin used for the Web Application Firewall.
* The origin must already be included in {@code Origins}. Required when creating the {@code
* WafConfig} resource, but is not required upon updating the configuration.
*
* @return the value
*/
public String getOrigin() {
return origin;
}
/** A list of caching rules applied to the web application. */
@com.fasterxml.jackson.annotation.JsonProperty("cachingRules")
private final java.util.List cachingRules;
/**
* A list of caching rules applied to the web application.
*
* @return the value
*/
public java.util.List getCachingRules() {
return cachingRules;
}
/** A list of the custom protection rule OCIDs and their actions. */
@com.fasterxml.jackson.annotation.JsonProperty("customProtectionRules")
private final java.util.List customProtectionRules;
/**
* A list of the custom protection rule OCIDs and their actions.
*
* @return the value
*/
public java.util.List getCustomProtectionRules() {
return customProtectionRules;
}
/**
* The map of origin groups and their keys used to associate origins to the {@code wafConfig}.
* Origin groups allow you to apply weights to groups of origins for load balancing purposes.
* Origins with higher weights will receive larger proportions of client requests. To add
* additional origins to your WAAS policy, update the {@code origins} field of a {@code
* UpdateWaasPolicy} request.
*/
@com.fasterxml.jackson.annotation.JsonProperty("originGroups")
private final java.util.List originGroups;
/**
* The map of origin groups and their keys used to associate origins to the {@code wafConfig}.
* Origin groups allow you to apply weights to groups of origins for load balancing purposes.
* Origins with higher weights will receive larger proportions of client requests. To add
* additional origins to your WAAS policy, update the {@code origins} field of a {@code
* UpdateWaasPolicy} request.
*
* @return the value
*/
public java.util.List getOriginGroups() {
return originGroups;
}
/** The settings applied to protection rules. */
@com.fasterxml.jackson.annotation.JsonProperty("protectionSettings")
private final ProtectionSettings protectionSettings;
/**
* The settings applied to protection rules.
*
* @return the value
*/
public ProtectionSettings getProtectionSettings() {
return protectionSettings;
}
/** A list of IP addresses that bypass the Web Application Firewall. */
@com.fasterxml.jackson.annotation.JsonProperty("whitelists")
private final java.util.List whitelists;
/**
* A list of IP addresses that bypass the Web Application Firewall.
*
* @return the value
*/
public java.util.List getWhitelists() {
return whitelists;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("WafConfigDetails(");
sb.append("super=").append(super.toString());
sb.append("accessRules=").append(String.valueOf(this.accessRules));
sb.append(", addressRateLimiting=").append(String.valueOf(this.addressRateLimiting));
sb.append(", captchas=").append(String.valueOf(this.captchas));
sb.append(", deviceFingerprintChallenge=")
.append(String.valueOf(this.deviceFingerprintChallenge));
sb.append(", humanInteractionChallenge=")
.append(String.valueOf(this.humanInteractionChallenge));
sb.append(", jsChallenge=").append(String.valueOf(this.jsChallenge));
sb.append(", origin=").append(String.valueOf(this.origin));
sb.append(", cachingRules=").append(String.valueOf(this.cachingRules));
sb.append(", customProtectionRules=").append(String.valueOf(this.customProtectionRules));
sb.append(", originGroups=").append(String.valueOf(this.originGroups));
sb.append(", protectionSettings=").append(String.valueOf(this.protectionSettings));
sb.append(", whitelists=").append(String.valueOf(this.whitelists));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof WafConfigDetails)) {
return false;
}
WafConfigDetails other = (WafConfigDetails) o;
return java.util.Objects.equals(this.accessRules, other.accessRules)
&& java.util.Objects.equals(this.addressRateLimiting, other.addressRateLimiting)
&& java.util.Objects.equals(this.captchas, other.captchas)
&& java.util.Objects.equals(
this.deviceFingerprintChallenge, other.deviceFingerprintChallenge)
&& java.util.Objects.equals(
this.humanInteractionChallenge, other.humanInteractionChallenge)
&& java.util.Objects.equals(this.jsChallenge, other.jsChallenge)
&& java.util.Objects.equals(this.origin, other.origin)
&& java.util.Objects.equals(this.cachingRules, other.cachingRules)
&& java.util.Objects.equals(this.customProtectionRules, other.customProtectionRules)
&& java.util.Objects.equals(this.originGroups, other.originGroups)
&& java.util.Objects.equals(this.protectionSettings, other.protectionSettings)
&& java.util.Objects.equals(this.whitelists, other.whitelists)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.accessRules == null ? 43 : this.accessRules.hashCode());
result =
(result * PRIME)
+ (this.addressRateLimiting == null
? 43
: this.addressRateLimiting.hashCode());
result = (result * PRIME) + (this.captchas == null ? 43 : this.captchas.hashCode());
result =
(result * PRIME)
+ (this.deviceFingerprintChallenge == null
? 43
: this.deviceFingerprintChallenge.hashCode());
result =
(result * PRIME)
+ (this.humanInteractionChallenge == null
? 43
: this.humanInteractionChallenge.hashCode());
result = (result * PRIME) + (this.jsChallenge == null ? 43 : this.jsChallenge.hashCode());
result = (result * PRIME) + (this.origin == null ? 43 : this.origin.hashCode());
result = (result * PRIME) + (this.cachingRules == null ? 43 : this.cachingRules.hashCode());
result =
(result * PRIME)
+ (this.customProtectionRules == null
? 43
: this.customProtectionRules.hashCode());
result = (result * PRIME) + (this.originGroups == null ? 43 : this.originGroups.hashCode());
result =
(result * PRIME)
+ (this.protectionSettings == null
? 43
: this.protectionSettings.hashCode());
result = (result * PRIME) + (this.whitelists == null ? 43 : this.whitelists.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy