Namespace Oci.AdmService.Models
Classes
ApplicationDependency
An application dependency resource creates a vulnerability audit.
ApplicationDependencyRecommendationCollection
A collection of recommended application dependency changes. Each element consists of an application dependency and its recommendation.
ApplicationDependencyRecommendationSummary
An application dependency with the recommended version that does not contain any CVE. Each application dependency has a property specifying multiple node identifiers on which which this current node depends.
ApplicationDependencyVulnerabilityCollection
application dependencies with Vulnerabilities. This resource is defined by a list of application dependencies that are associated with eventual Vulnerabilities.
ApplicationDependencyVulnerabilitySummary
An application dependency Vulnerability represents a single dependency in the application. An application dependency Vulnerability can be associated with eventual Vulnerabilities. Each application dependency is uniquely defined by a nodeId and lists eventual dependencies on which it depends.
ApplyStage
An apply stage merges the changes if the pull request is accepted.
ChangeKnowledgeBaseCompartmentDetails
Details for moving a knowledge base.
ChangeRemediationRecipeCompartmentDetails
Details for moving a remediation recipe resource.
ChangeRemediationRunCompartmentDetails
Details for moving remediation run resources.
ChangeVulnerabilityAuditCompartmentDetails
Details for moving a vulnerability audit resource.
CreateKnowledgeBaseDetails
Details to create a new knowledge base.
CreateRemediationRecipeDetails
Details to create a new Remediation Recipe.
CreateRemediationRunDetails
Details to create a new remediation run.
CreateVulnerabilityAuditDetails
Details to create a vulnerability audit.
DetectConfiguration
A configuration to define the constraints when detecting vulnerable dependencies.
DetectStage
A detect stage performs a Vulnerability Audit and determines if the remediation run should proceed to remediation stage.
ExternalResourceVulnerabilityAuditSource
External source for the vulnerability audit.
ExternalScmConfiguration
An external SCM configuration extends a SCM Configuration with necessary data to reach and use the Source Code Management tool/platform used by a Remediation Recipe. An external SCM in ADM refers to GitHub, or GitLab.
GitHubActionsConfiguration
Extends a Verify configuration with appropriate data to reach and use the build service provided by a GitHub Action.
GitLabPipelineConfiguration
Extends a Verify configuration with appropriate data to reach and use the build service provided by a GitLab Pipeline.
JenkinsPipelineConfiguration
Extends a Verify configuration with appropriate data to reach and use the build service provided by a Jenkins Pipeline.
KnowledgeBase
A knowledge base is a component of Application Dependency Management (ADM) service that provides access to vulnerabilities.
KnowledgeBaseCollection
Collection of knowledge base summaries.
KnowledgeBaseSummary
The summary of a knowledge base.
NetworkConfiguration
A network configuration defines the required network characteristics for an ADM remediation recipe. A network configuration is required if the build service is one of: GitHub Actions, GitLab Pipeline, or Jenkins Pipeline.
NoneVerifyConfiguration
Empty verify configuration when no build was selected.
OciCodeRepositoryConfiguration
An OCI Code repository configuration extends a SCM Configuration with necessary data to reach and use the OCI DevOps Code Repository.
OciDevOpsBuildConfiguration
OCI DevOps configuration extends a Verify Configuration with necessary data to reach and use the OCI DevOps Build Service.
OciResourceVulnerabilityAuditSource
OCI resource source for the vulnerability audit.
PipelineProperties
Pipeline properties which result from the run of the verify stage.
PullRequestProperties
Pull request properties from recommend stage of the remediation run.
RecommendStage
A recommend stage determines the recommended third-party dependencies that the app should use and (if any) opens a pull request to propose these changes.
RemediationRecipe
An Application Dependency Management (ADM) remediation recipe contains the basic configuration and the details of each of the remediation stages (Detect, Recommend, Verify, and Apply).
RemediationRecipeCollection
Collection of remediation recipe summaries.
RemediationRecipeSummary
The summary of a Remediation Recipe.
RemediationRun
A remediation run represents an execution of a Remediation Recipe to detect and fix vulnerabilities based on current state of the Vulnerabilities curated in the Knowledge Base. A Run can be triggered manually or when a new CVE is discovered.
RemediationRunCollection
Collection of remediation run summaries.
RemediationRunStage
A remediation run stage is one step of an remediation run. Each stage provides output logs and has a specific type. The stages are: DETECT, RECOMMEND, VERIFY, and APPLY.
RemediationRunStageCollection
Collection of remediation run stage summaries.
RemediationRunStageModelConverter
RemediationRunStageSummary
The summary of a remediation run stages.
RemediationRunSummary
remediation run summary.
ScmConfiguration
A configuration for the Source Code Management tool/platform used by a remediation recipe.
ScmConfigurationModelConverter
StageSummary
stage summary of a remediation run. A stage is one step of a remediation run.
UnknownSourceVulnerabilityAuditSource
Unknown source for vulnerability audit.
UpdateKnowledgeBaseDetails
Details to update an existing knowledge base.
UpdateRemediationRecipeDetails
Details to update an existing remediation recipe.
UpdateRemediationRunDetails
Details to update an existing remediation run.
UpdateVulnerabilityAuditDetails
Details to update a vulnerability audit.
UsageDataDetails
The source details of the usage data in object storage. The usage data file uploaded to object storage must be a gzip archive
of the JSON usage data returned from the GraalVM native-image-inspect tool after a native-image build.
Set sourceType
to objectStorageTuple
and use {@link #usageDataViaObjectStorageTupleDetails(UsageDataViaObjectStorageTupleDetailsRequest) usageDataViaObjectStorageTupleDetails}
when specifying the namespace, bucket name, and object name.
UsageDataDetailsModelConverter
UsageDataViaObjectStorageTupleDetails
Reference to an object in object storage as a tuple. The usage data file uploaded to object storage must be a gzip archive of the JSON usage data returned from the GraalVM native-image-inspect tool after a native-image build.
VerifyConfiguration
The Verify stage configuration specifies a build service to run a pipeline for the recommended code changes. The build pipeline will be initiated to ensure that there is no breaking change after the dependency versions have been updated in source to avoid vulnerabilities.
VerifyConfigurationModelConverter
VerifyStage
A verify stage will run a build pipeline in a branch.
Vulnerability
A vulnerability is a weakness or error in an artifact. A vulnerability is a generalization of a CVE (every CVE is a vulnerability, but not every vulnerability has a CVE).
VulnerabilityAudit
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.
VulnerabilityAuditCollection
Collection of vulnerability audit summaries.
VulnerabilityAuditConfiguration
Configuration for a vulnerability audit.
A vulnerable application dependency is ignored if its name does match any of the items in exclusions
, or all of the associated Vulnerabilies have a CVSS v2 score below maxPermissibleCvssV2Score
and a CVSS v3 score below maxPermissibleCvssV3Score
.
type: object
VulnerabilityAuditSource
vulnerability audit source.
VulnerabilityAuditSourceModelConverter
VulnerabilityAuditSummary
vulnerability audit summary.
WorkRequest
A description of workrequest status
WorkRequestError
An error encountered while executing a work request.
WorkRequestErrorCollection
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
WorkRequestLogEntry
A log message from the execution of a work request.
WorkRequestLogEntryCollection
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
WorkRequestResource
A resource created or operated on by a work request.
WorkRequestSummary
A summary of the status of a work request.
WorkRequestSummaryCollection
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
Enums
ActionType
Possible types of actions.
ConfigSeverity
Qualitative evaluation of the severity for a vulnerability, from NONE to CRITICAL. Used to configure requests that specify severity requirements, that's why UNSET is also a valid value (unlike in VulnerabilitySeverity).
DetectConfiguration.UpgradePolicyEnum
ExternalScmConfiguration.ExternalScmTypeEnum
KnowledgeBase.LifecycleStateEnum
OperationStatus
Possible operation status.
OperationType
Possible operation types.
RemediationRecipe.LifecycleStateEnum
RemediationRun.LifecycleStateEnum
RemediationRun.RemediationRunSourceEnum
RemediationRunStage.StatusEnum
RemediationRunStageType
Remediation Run stage type.
ScmConfiguration.ScmTypeEnum
SortOrder
Sort orders.
VerifyConfiguration.BuildServiceTypeEnum
VulnerabilityAudit.BuildTypeEnum
VulnerabilityAudit.LifecycleDetailsEnum
VulnerabilityAudit.LifecycleStateEnum
VulnerabilityAuditSource.TypeEnum
VulnerabilitySeverity
Qualitative evaluation of the severity for a vulnerability, from NONE to CRITICAL.
WorkRequestResourceMetadataKey
Possible Metadata keys for workRequest resource metadata