Package com.oracle.bmc.adm.model

Class VulnerabilityAudit

  • @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).

    • Method Detail

      • getId

        public String getId()
        The Oracle Cloud identifier (OCID) of the vulnerability audit.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The name of the vulnerability audit.
        Returns:
        the value

      • getKnowledgeBaseId

        public String getKnowledgeBaseId()
        The Oracle Cloud identifier (OCID) of the knowledge base.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The creation date and time of the vulnerability audit (formatted according to RFC3339).
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The update date and time of the vulnerability audit (formatted according to RFC3339).
        Returns:
        the value

      • getVulnerabilities

        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.

        Returns:
        the value

      • getMaxObservedCvssV2Score

        public Float getMaxObservedCvssV2Score()
        Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies.
        Returns:
        the value

      • getMaxObservedCvssV3Score

        public Float getMaxObservedCvssV3Score()
        Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies.
        Returns:
        the value

      • getMaxObservedSeverity

        public VulnerabilitySeverity getMaxObservedSeverity()
        Maximum ADM Severity observed for non-ignored vulnerable application dependencies.
        Returns:
        the value

      • getMaxObservedCvssV2ScoreWithIgnored

        public Float getMaxObservedCvssV2ScoreWithIgnored()
        Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones.
        Returns:
        the value

      • getMaxObservedCvssV3ScoreWithIgnored

        public Float getMaxObservedCvssV3ScoreWithIgnored()
        Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones.
        Returns:
        the value

      • getMaxObservedSeverityWithIgnored

        public VulnerabilitySeverity getMaxObservedSeverityWithIgnored()
        Maximum ADM Severity observed for vulnerable application dependencies including ignored ones.
        Returns:
        the value

      • getVulnerableArtifactsCountWithIgnored

        public Integer getVulnerableArtifactsCountWithIgnored()
        Count of all vulnerable application dependencies.
        Returns:
        the value

      • getVulnerableArtifactsCount

        public Integer getVulnerableArtifactsCount()
        Count of non-ignored vulnerable application dependencies.
        Returns:
        the value

      • getIsSuccess

        public Boolean getIsSuccess()
        Indicates if an audit succeeded according to the configuration.

        The value is null if the audit is in the CREATING state.

        Returns:
        the value

      • getBuildType

        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.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The compartment Oracle Cloud identifier (OCID) of the vulnerability audit.
        Returns:
        the value

      • getFreeformTags

        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”}

        Returns:
        the value

      • getDefinedTags

        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”}}

        Returns:
        the value

      • getSystemTags

        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”}}

        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