Package com.oracle.bmc.waas.model

Class Recommendation

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.waas.model.Recommendation

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public final class Recommendation
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A recommended protection rule for a web application.

This recommendation can be accepted to apply it to the Web Application Firewall configuration for this policy.

Use the POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations method to accept recommended protection rules.
Note: Objects should always be created or deserialized using the Recommendation.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Recommendation.Builder, which maintain a set of all explicitly set fields called Recommendation.Builder.__explicitlySet__. The hashCode() and 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 null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Recommendation.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
Recommendation(String key, List<String> modSecurityRuleIds, String name, String description, List<String> labels, String recommendedAction)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Recommendation.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	The description of the recommended protection rule.
String	getKey()	The unique key for the recommended protection rule.
List<String>	getLabels()	The list of labels for the recommended protection rule.
List<String>	getModSecurityRuleIds()	The list of the ModSecurity rule IDs associated with the protection rule.
String	getName()	The name of the recommended protection rule.
String	getRecommendedAction()	The recommended action to apply to the protection rule.
int	hashCode()
Recommendation.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Recommendation

@Deprecated
@ConstructorProperties({"key","modSecurityRuleIds","name","description","labels","recommendedAction"})
public Recommendation(String key,
                      List<String> modSecurityRuleIds,
                      String name,
                      String description,
                      List<String> labels,
                      String recommendedAction)

Deprecated.

Method Detail

builder

public static Recommendation.Builder builder()

Create a new builder.

toBuilder

public Recommendation.Builder toBuilder()

getKey

public String getKey()

The unique key for the recommended protection rule.

Returns:

the value

getModSecurityRuleIds

public List<String> getModSecurityRuleIds()

The list of the ModSecurity rule IDs associated with the protection rule.

For more information about ModSecurity’s open source WAF rules, see Mod Security’s documentation.

Returns:

the value

getName

public String getName()

The name of the recommended protection rule.

Returns:

the value

getDescription

public String getDescription()

The description of the recommended protection rule.

Returns:

the value

getLabels

public List<String> getLabels()

The list of labels for the recommended protection rule.

Returns:

the value

getRecommendedAction

public String getRecommendedAction()

The recommended action to apply to the protection rule.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel