@Generated(value="OracleSDKGenerator",
comments="API Version: 20220421")
public final class VulnerabilityAudit
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A vulnerability audit associates the application dependencies of a project with their associated
Vulnerabilities. Each Vulnerability is associated with a score (Common Vulnerability Scoring
System V2 or V3). A vulnerable application dependency can be ignored based on the configuration
of the vulnerability audit. maxObservedCvssV2Score, maxObservedCvssV3Score and
vulnerableArtifactsCount do not take into account non-vulnerable application dependency.
Note: Objects should always be created or deserialized using the VulnerabilityAudit.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 VulnerabilityAudit.Builder, which maintain a
set of all explicitly set fields called VulnerabilityAudit.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
VulnerabilityAudit.Builder |
static class |
VulnerabilityAudit.BuildType
The type of the build tool is restricted to only two values MAVEN or UNSET.
|
static class |
VulnerabilityAudit.LifecycleDetails
Details on the lifecycle state.
|
static class |
VulnerabilityAudit.LifecycleState
The current lifecycle state of the vulnerability audit.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
VulnerabilityAudit(String id,
String displayName,
String knowledgeBaseId,
Date timeCreated,
Date timeUpdated,
VulnerabilityAudit.LifecycleState lifecycleState,
VulnerabilityAudit.LifecycleDetails lifecycleDetails,
List<Vulnerability> vulnerabilities,
Float maxObservedCvssV2Score,
Float maxObservedCvssV3Score,
VulnerabilitySeverity maxObservedSeverity,
Float maxObservedCvssV2ScoreWithIgnored,
Float maxObservedCvssV3ScoreWithIgnored,
VulnerabilitySeverity maxObservedSeverityWithIgnored,
Integer vulnerableArtifactsCountWithIgnored,
Integer vulnerableArtifactsCount,
VulnerabilityAuditConfiguration configuration,
UsageDataDetails usageData,
Boolean isSuccess,
VulnerabilityAudit.BuildType buildType,
VulnerabilityAuditSource source,
String compartmentId,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static VulnerabilityAudit.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
VulnerabilityAudit.BuildType |
getBuildType()
The type of the build tool is restricted to only two values MAVEN or UNSET.
|
String |
getCompartmentId()
The compartment Oracle Cloud identifier
(OCID) of the
vulnerability audit.
|
VulnerabilityAuditConfiguration |
getConfiguration() |
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The name of the vulnerability audit.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The Oracle Cloud identifier
(OCID) of the
vulnerability audit.
|
Boolean |
getIsSuccess()
Indicates if an audit succeeded according to the configuration.
|
String |
getKnowledgeBaseId()
The Oracle Cloud identifier
(OCID) of the
knowledge base.
|
VulnerabilityAudit.LifecycleDetails |
getLifecycleDetails()
Details on the lifecycle state.
|
VulnerabilityAudit.LifecycleState |
getLifecycleState()
The current lifecycle state of the vulnerability audit.
|
Float |
getMaxObservedCvssV2Score()
Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored
vulnerable application dependencies.
|
Float |
getMaxObservedCvssV2ScoreWithIgnored()
Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable
application dependencies including ignored ones.
|
Float |
getMaxObservedCvssV3Score()
Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored
vulnerable application dependencies.
|
Float |
getMaxObservedCvssV3ScoreWithIgnored()
Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable
application dependencies including ignored ones.
|
VulnerabilitySeverity |
getMaxObservedSeverity()
Maximum ADM Severity observed for non-ignored vulnerable application dependencies.
|
VulnerabilitySeverity |
getMaxObservedSeverityWithIgnored()
Maximum ADM Severity observed for vulnerable application dependencies including ignored ones.
|
VulnerabilityAuditSource |
getSource() |
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The creation date and time of the vulnerability audit (formatted according to
RFC3339).
|
Date |
getTimeUpdated()
The update date and time of the vulnerability audit (formatted according to
RFC3339).
|
UsageDataDetails |
getUsageData() |
List<Vulnerability> |
getVulnerabilities()
List of vulnerabilities found in the vulnerability audit.
|
Integer |
getVulnerableArtifactsCount()
Count of non-ignored vulnerable application dependencies.
|
Integer |
getVulnerableArtifactsCountWithIgnored()
Count of all vulnerable application dependencies.
|
int |
hashCode() |
VulnerabilityAudit.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","knowledgeBaseId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","vulnerabilities","maxObservedCvssV2Score","maxObservedCvssV3Score","maxObservedSeverity","maxObservedCvssV2ScoreWithIgnored","maxObservedCvssV3ScoreWithIgnored","maxObservedSeverityWithIgnored","vulnerableArtifactsCountWithIgnored","vulnerableArtifactsCount","configuration","usageData","isSuccess","buildType","source","compartmentId","freeformTags","definedTags","systemTags"}) public VulnerabilityAudit(String id, String displayName, String knowledgeBaseId, Date timeCreated, Date timeUpdated, VulnerabilityAudit.LifecycleState lifecycleState, VulnerabilityAudit.LifecycleDetails lifecycleDetails, List<Vulnerability> vulnerabilities, Float maxObservedCvssV2Score, Float maxObservedCvssV3Score, VulnerabilitySeverity maxObservedSeverity, Float maxObservedCvssV2ScoreWithIgnored, Float maxObservedCvssV3ScoreWithIgnored, VulnerabilitySeverity maxObservedSeverityWithIgnored, Integer vulnerableArtifactsCountWithIgnored, Integer vulnerableArtifactsCount, VulnerabilityAuditConfiguration configuration, UsageDataDetails usageData, Boolean isSuccess, VulnerabilityAudit.BuildType buildType, VulnerabilityAuditSource source, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static VulnerabilityAudit.Builder builder()
Create a new builder.
public VulnerabilityAudit.Builder toBuilder()
public String getId()
The Oracle Cloud identifier (OCID) of the vulnerability audit.
public String getDisplayName()
The name of the vulnerability audit.
public String getKnowledgeBaseId()
The Oracle Cloud identifier (OCID) of the knowledge base.
public Date getTimeCreated()
The creation date and time of the vulnerability audit (formatted according to RFC3339).
public Date getTimeUpdated()
The update date and time of the vulnerability audit (formatted according to RFC3339).
public VulnerabilityAudit.LifecycleState getLifecycleState()
The current lifecycle state of the vulnerability audit.
public VulnerabilityAudit.LifecycleDetails getLifecycleDetails()
Details on the lifecycle state.
public List<Vulnerability> getVulnerabilities()
List of vulnerabilities found in the vulnerability audit. If a vulnerability affects multiple dependencies, the metadata returned here consists of audit-wide aggregates.
public Float getMaxObservedCvssV2Score()
Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies.
public Float getMaxObservedCvssV3Score()
Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies.
public VulnerabilitySeverity getMaxObservedSeverity()
Maximum ADM Severity observed for non-ignored vulnerable application dependencies.
public Float getMaxObservedCvssV2ScoreWithIgnored()
Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones.
public Float getMaxObservedCvssV3ScoreWithIgnored()
Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones.
public VulnerabilitySeverity getMaxObservedSeverityWithIgnored()
Maximum ADM Severity observed for vulnerable application dependencies including ignored ones.
public Integer getVulnerableArtifactsCountWithIgnored()
Count of all vulnerable application dependencies.
public Integer getVulnerableArtifactsCount()
Count of non-ignored vulnerable application dependencies.
public VulnerabilityAuditConfiguration getConfiguration()
public UsageDataDetails getUsageData()
public Boolean getIsSuccess()
Indicates if an audit succeeded according to the configuration. The value is null if
the audit is in the CREATING state.
public VulnerabilityAudit.BuildType getBuildType()
The type of the build tool is restricted to only two values MAVEN or UNSET. Use UNSET when the list of application dependencies is not Maven-related or is a mix of Maven and other ecosystems. This option is soon to be deprecated.
public VulnerabilityAuditSource getSource()
public String getCompartmentId()
The compartment Oracle Cloud identifier (OCID) of the vulnerability audit.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.