Package com.oracle.bmc.adm.model

Class DetectConfiguration

java.lang.Object

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

com.oracle.bmc.adm.model.DetectConfiguration

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

A configuration to define the constraints when detecting vulnerable dependencies and recommending remediations.
Note: Objects should always be created or deserialized using the DetectConfiguration.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 DetectConfiguration.Builder, which maintain a set of all explicitly set fields called DetectConfiguration.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	DetectConfiguration.Builder
static class	DetectConfiguration.UpgradePolicy	The upgrade policy for recommendations.

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
DetectConfiguration(List<String> exclusions, DetectConfiguration.UpgradePolicy upgradePolicy, Float maxPermissibleCvssV2Score, Float maxPermissibleCvssV3Score, ConfigSeverity maxPermissibleSeverity)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static DetectConfiguration.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<String>	getExclusions()	The list of dependencies to be ignored by the recommendation algorithm.
Float	getMaxPermissibleCvssV2Score()	The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score.
Float	getMaxPermissibleCvssV3Score()	The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score.
ConfigSeverity	getMaxPermissibleSeverity()	The maximum ADM Severity.
DetectConfiguration.UpgradePolicy	getUpgradePolicy()	The upgrade policy for recommendations.
int	hashCode()
DetectConfiguration.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

DetectConfiguration

@Deprecated
@ConstructorProperties({"exclusions","upgradePolicy","maxPermissibleCvssV2Score","maxPermissibleCvssV3Score","maxPermissibleSeverity"})
public DetectConfiguration(List<String> exclusions,
                           DetectConfiguration.UpgradePolicy upgradePolicy,
                           Float maxPermissibleCvssV2Score,
                           Float maxPermissibleCvssV3Score,
                           ConfigSeverity maxPermissibleSeverity)

Deprecated.

Method Detail

builder

public static DetectConfiguration.Builder builder()

Create a new builder.

toBuilder

public DetectConfiguration.Builder toBuilder()

getExclusions

public List<String> getExclusions()

The list of dependencies to be ignored by the recommendation algorithm.

The dependency pattern is matched against the ‘group:artifact:version’ or the purl of a dependency. An asterisk (*) at the end in the dependency pattern acts as a wildcard and matches zero or more characters.

Returns:

the value

getUpgradePolicy

public DetectConfiguration.UpgradePolicy getUpgradePolicy()

The upgrade policy for recommendations.

The Nearest upgrade policy upgrades a dependency to the oldest version that meets both of the following criteria: it is newer than the current version and it is not affected by a vulnerability.

Returns:

the value

getMaxPermissibleCvssV2Score

public Float getMaxPermissibleCvssV2Score()

The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score.

A vulnerability with a CVSS V2 score below this value is not considered for remediation.

Returns:

the value

getMaxPermissibleCvssV3Score

public Float getMaxPermissibleCvssV3Score()

The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score.

A vulnerability with a CVSS V3 score below this value is not considered for patching.

Returns:

the value

getMaxPermissibleSeverity

public ConfigSeverity getMaxPermissibleSeverity()

The maximum ADM Severity.

A vulnerability with an severity below this value is not considered for remediation.

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