CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_T Type 🔗
An application dependency resource creates a vulnerability audit.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_t FORCE AUTHID CURRENT_USER IS OBJECT (
gav varchar2(32767),
node_id varchar2(32767),
application_dependency_node_ids dbms_cloud_oci_adm_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_t (
gav varchar2,
node_id varchar2,
application_dependency_node_ids dbms_cloud_oci_adm_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
gav
(required) Group Artifact Version (GAV) identifier (Group:Artifact:Version), e.g. org.graalvm.nativeimage:svm:21.1.0.
node_id
(required) Unique identifier of an application dependency, for example nodeId1. The nodeId can be generated by assigning a unique id to each application dependency in the tree of application dependencies. Every node, even those who share the same GAV, should have a different nodeId. The preferred way of constructing a nodeId is to assign incremental integers during a breadth first or depth first search. A nodeId can be reused only it refers to the same subtree of application dependencies. (This is not equivalent to referring to the same GAV, that is, a GAV can have multiple transitive dependencies.)
application_dependency_node_ids
(optional) List of application dependencies on which this application dependency depends, each identified by its nodeId.
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_RECOMMENDATION_SUMMARY_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_recommendation_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
gav varchar2(32767),
node_id varchar2(32767),
application_dependency_node_ids dbms_cloud_oci_adm_varchar2_tbl,
recommended_gav varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_recommendation_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_recommendation_summary_t (
gav varchar2,
node_id varchar2,
application_dependency_node_ids dbms_cloud_oci_adm_varchar2_tbl,
recommended_gav varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
gav
(required) Unique Group Artifact Version (GAV) identifier in the format _Group:Artifact:Version_, e.g. org.graalvm.nativeimage:svm:21.1.0.
node_id
(required) Unique node identifier of an application dependency with an associated Recommendation, e.g. nodeId1.
application_dependency_node_ids
(required) List of (application dependencies) node identifiers from which this node depends.
recommended_gav
(optional) Recommended application dependency in \"group:artifact:version\" (GAV) format, e.g. org.graalvm.nativeimage:svm:21.2.0.
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_RECOMMENDATION_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_application_dependency_recommendation_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_recommendation_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_application_dependency_recommendation_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_RECOMMENDATION_COLLECTION_T Type 🔗
A collection of recommended application dependency changes. Each element consists of an application dependency and its recommendation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_recommendation_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_application_dependency_recommendation_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_recommendation_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_recommendation_collection_t (
items dbms_cloud_oci_adm_application_dependency_recommendation_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of application recommendation summaries.
DBMS_CLOUD_OCI_ADM_VULNERABILITY_T Type 🔗
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).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
cvss_v2_score number,
cvss_v3_score number,
is_ignored number,
is_false_positive number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_t (
id varchar2,
cvss_v2_score number,
cvss_v3_score number,
is_ignored number,
is_false_positive number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) Unique vulnerability identifier, e.g. CVE-1999-0067.
cvss_v2_score
(required) Common Vulnerability Scoring System (CVSS) Version 2.
cvss_v3_score
(required) Common Vulnerability Scoring System (CVSS) Version 3.
is_ignored
(required) Indicates if the vulnerability was ignored according to the audit configuration.
is_false_positive
(optional) Indicates if the vulnerability is a false positive according to the usage data. If no usage data was provided or the service cannot infer usage of the vulnerable code then this property is `null`.
DBMS_CLOUD_OCI_ADM_VULNERABILITY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_vulnerability_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_vulnerability_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_VULNERABILITY_SUMMARY_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_vulnerability_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
gav varchar2(32767),
node_id varchar2(32767),
application_dependency_node_ids dbms_cloud_oci_adm_varchar2_tbl,
vulnerabilities dbms_cloud_oci_adm_vulnerability_tbl,
is_found_in_knowledge_base number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_vulnerability_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_vulnerability_summary_t (
gav varchar2,
node_id varchar2,
application_dependency_node_ids dbms_cloud_oci_adm_varchar2_tbl,
vulnerabilities dbms_cloud_oci_adm_vulnerability_tbl,
is_found_in_knowledge_base number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
gav
(required) Group Artifact Version (GAV) identifier (Group:Artifact:Version), for example org.graalvm.nativeimage:svm:21.1.0.
node_id
(required) Unique identifier of an application dependency, for example nodeId1.
application_dependency_node_ids
(required) List of application dependencies on which this application dependency depends, each identified by its nodeId.
vulnerabilities
(required) List of vulnerabilities for the application dependency.
is_found_in_knowledge_base
(required) Indicates if the artifact is found in the knowledge base.
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_VULNERABILITY_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_application_dependency_vulnerability_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_vulnerability_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_application_dependency_vulnerability_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_VULNERABILITY_COLLECTION_T Type 🔗
application dependencies with Vulnerabilities. This resource is defined by a list of application dependencies that are associated with eventual Vulnerabilities.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_vulnerability_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_application_dependency_vulnerability_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_vulnerability_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_application_dependency_vulnerability_collection_t (
items dbms_cloud_oci_adm_application_dependency_vulnerability_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of vulnerability audit summaries.
DBMS_CLOUD_OCI_ADM_PULL_REQUEST_PROPERTIES_T Type 🔗
Pull request properties from recommend stage of the remediation run.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_pull_request_properties_t FORCE AUTHID CURRENT_USER IS OBJECT (
pull_request_identifier varchar2(32767),
pull_request_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_pull_request_properties_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_pull_request_properties_t (
pull_request_identifier varchar2,
pull_request_url varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
pull_request_identifier
(optional) Unique identifier for the pull or merge request created in the recommend stage.
pull_request_url
(optional) The web link to the pull or merge request created in the recommend stage.
DBMS_CLOUD_OCI_ADM_PIPELINE_PROPERTIES_T Type 🔗
Pipeline properties which result from the run of the verify stage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_pipeline_properties_t FORCE AUTHID CURRENT_USER IS OBJECT (
pipeline_identifier varchar2(32767),
pipeline_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_pipeline_properties_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_pipeline_properties_t (
pipeline_identifier varchar2,
pipeline_url varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
pipeline_identifier
(optional) Unique identifier for the pipeline or action created in the Verify stage.
pipeline_url
(optional) The web link to the pipeline from the Verify stage.
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_STAGE_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_stage_t FORCE AUTHID CURRENT_USER IS OBJECT (
status varchar2(32767),
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2(32767),
summary varchar2(32767),
remediation_run_id varchar2(32767),
previous_stage_type varchar2(32767),
next_stage_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_stage_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_stage_t (
status varchar2,
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2,
summary varchar2,
remediation_run_id varchar2,
previous_stage_type varchar2,
next_stage_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field
Description
status
(required) The current status of a remediation run stage.
An apply stage merges the changes if the pull request is accepted.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_apply_stage_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_remediation_run_stage_t (
pull_request_properties dbms_cloud_oci_adm_pull_request_properties_t,
pipeline_properties dbms_cloud_oci_adm_pipeline_properties_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_apply_stage_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_apply_stage_t (
status varchar2,
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2,
summary varchar2,
remediation_run_id varchar2,
previous_stage_type varchar2,
next_stage_type varchar2,
pull_request_properties dbms_cloud_oci_adm_pull_request_properties_t,
pipeline_properties dbms_cloud_oci_adm_pipeline_properties_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_apply_stage_t is a subtype of the dbms_cloud_oci_adm_remediation_run_stage_t type.
Fields
Field
Description
pull_request_properties
(optional)
pipeline_properties
(optional)
DBMS_CLOUD_OCI_ADM_CHANGE_KNOWLEDGE_BASE_COMPARTMENT_DETAILS_T Type 🔗
Details for moving a knowledge base.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_change_knowledge_base_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_knowledge_base_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_knowledge_base_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
compartment_id
(required) The compartment Oracle Cloud Identifier (OCID) to which the resource must be moved.
DBMS_CLOUD_OCI_ADM_CHANGE_REMEDIATION_RECIPE_COMPARTMENT_DETAILS_T Type 🔗
Details for moving a remediation recipe resource.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_change_remediation_recipe_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_remediation_recipe_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_remediation_recipe_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
compartment_id
(required) The compartment Oracle Cloud Identifier (OCID) to which the resource must be moved.
DBMS_CLOUD_OCI_ADM_CHANGE_REMEDIATION_RUN_COMPARTMENT_DETAILS_T Type 🔗
Details for moving remediation run resources.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_change_remediation_run_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_remediation_run_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_remediation_run_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
compartment_id
(required) The compartment Oracle Cloud Identifier (OCID) to which the resource must be moved.
DBMS_CLOUD_OCI_ADM_CHANGE_VULNERABILITY_AUDIT_COMPARTMENT_DETAILS_T Type 🔗
Details for moving a vulnerability audit resource.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_change_vulnerability_audit_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_vulnerability_audit_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_change_vulnerability_audit_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
compartment_id
(required) The OCID of the compartment to which the resource must be moved.
DBMS_CLOUD_OCI_ADM_CREATE_KNOWLEDGE_BASE_DETAILS_T Type 🔗
Details to create a new knowledge base.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_create_knowledge_base_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
display_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_knowledge_base_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_knowledge_base_details_t (
compartment_id varchar2,
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
compartment_id
(required) The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
display_name
(optional) The name of the knowledge base.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_SCM_CONFIGURATION_T Type 🔗
A configuration for the Source Code Management tool/platform used by a remediation recipe.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_scm_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
scm_type varchar2(32767),
branch varchar2(32767),
build_file_location varchar2(32767),
is_automerge_enabled number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_scm_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_scm_configuration_t (
scm_type varchar2,
branch varchar2,
build_file_location varchar2,
is_automerge_enabled number
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
(required) The branch used by ADM to patch vulnerabilities.
build_file_location
(optional) The location of the build file relative to the root of the repository. Only Maven build files (POM) are currently supported. If this property is not specified, ADM will use the build file located at the root of the repository.
is_automerge_enabled
(required) If true, the Pull Request (PR) will be merged after the verify stage completes successfully If false, the PR with the proposed changes must be reviewed and manually merged.
DBMS_CLOUD_OCI_ADM_VERIFY_CONFIGURATION_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_verify_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
build_service_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_verify_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_verify_configuration_t (
build_service_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
A configuration to define the constraints when detecting vulnerable dependencies.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_detect_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
exclusions dbms_cloud_oci_adm_varchar2_tbl,
upgrade_policy varchar2(32767),
max_permissible_cvss_v2_score number,
max_permissible_cvss_v3_score number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_detect_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_detect_configuration_t (
exclusions dbms_cloud_oci_adm_varchar2_tbl,
upgrade_policy varchar2,
max_permissible_cvss_v2_score number,
max_permissible_cvss_v3_score number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
exclusions
(optional) 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.
upgrade_policy
(optional) 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.
Allowed values are: 'NEAREST'
max_permissible_cvss_v2_score
(optional) The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score. An artifact with a CVSS V2 score below this value is not considered for patching.
max_permissible_cvss_v3_score
(optional) The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score. An artifact with a CVSS V3 score below this value is not considered for patching.
DBMS_CLOUD_OCI_ADM_NETWORK_CONFIGURATION_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_network_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
subnet_id varchar2(32767),
nsg_ids dbms_cloud_oci_adm_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_network_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_network_configuration_t (
subnet_id varchar2,
nsg_ids dbms_cloud_oci_adm_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
subnet_id
(required) The Oracle Cloud Identifier (OCID) of the subnet.
nsg_ids
(optional) The list of Oracle Cloud Identifiers (OCID) corresponding to Network Security Groups.
DBMS_CLOUD_OCI_ADM_CREATE_REMEDIATION_RECIPE_DETAILS_T Type 🔗
Details to create a new Remediation Recipe.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_create_remediation_recipe_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
display_name varchar2(32767),
scm_configuration dbms_cloud_oci_adm_scm_configuration_t,
verify_configuration dbms_cloud_oci_adm_verify_configuration_t,
detect_configuration dbms_cloud_oci_adm_detect_configuration_t,
network_configuration dbms_cloud_oci_adm_network_configuration_t,
knowledge_base_id varchar2(32767),
is_run_triggered_on_kb_change number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_remediation_recipe_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_remediation_recipe_details_t (
compartment_id varchar2,
display_name varchar2,
scm_configuration dbms_cloud_oci_adm_scm_configuration_t,
verify_configuration dbms_cloud_oci_adm_verify_configuration_t,
detect_configuration dbms_cloud_oci_adm_detect_configuration_t,
network_configuration dbms_cloud_oci_adm_network_configuration_t,
knowledge_base_id varchar2,
is_run_triggered_on_kb_change number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
compartment_id
(required) The compartment Oracle Cloud Identifier (OCID) of the remediation recipe.
display_name
(optional) The name of the remediation recipe.
scm_configuration
(required)
verify_configuration
(required)
detect_configuration
(required)
network_configuration
(required)
knowledge_base_id
(required) The Oracle Cloud Identifier (OCID) of the knowledge base.
is_run_triggered_on_kb_change
(required) Boolean indicating if a run should be automatically triggered once the knowledge base is updated.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_CREATE_REMEDIATION_RUN_DETAILS_T Type 🔗
Details to create a new remediation run.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_create_remediation_run_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
remediation_recipe_id varchar2(32767),
display_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_remediation_run_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_remediation_run_details_t (
remediation_recipe_id varchar2,
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
remediation_recipe_id
(required) The Oracle Cloud identifier (OCID) of the Remediation Recipe.
display_name
(optional) The name of the remediation run.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_VULNERABILITY_AUDIT_CONFIGURATION_T Type 🔗
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
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_audit_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
max_permissible_cvss_v2_score number,
max_permissible_cvss_v3_score number,
exclusions dbms_cloud_oci_adm_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_configuration_t (
max_permissible_cvss_v2_score number,
max_permissible_cvss_v3_score number,
exclusions dbms_cloud_oci_adm_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
max_permissible_cvss_v2_score
(optional) A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.
max_permissible_cvss_v3_score
(optional) A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.
exclusions
(optional) A vulnerable application dependency is ignored if its name matches any of the items in `exclusions`. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters.
DBMS_CLOUD_OCI_ADM_USAGE_DATA_DETAILS_T Type 🔗
The source details of the usage data on Object Storage. Set `sourceType` to `objectStorageTuple` and use USAGE_DATA_VIA_OBJECT_STORAGE_TUPLE_DETAILS Function when specifying the namespace, bucket name, and object name.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_usage_data_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
source_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_usage_data_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_usage_data_details_t (
source_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field
Description
source_type
(required) The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name.
DBMS_CLOUD_OCI_ADM_VULNERABILITY_AUDIT_SOURCE_T Type 🔗
vulnerability audit source.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_audit_source_t FORCE AUTHID CURRENT_USER IS OBJECT (
l_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_source_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_source_t (
l_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field
Description
l_type
(required) Source type of the vulnerability audit.
DBMS_CLOUD_OCI_ADM_APPLICATION_DEPENDENCY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_application_dependency_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_application_dependency_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_application_dependency_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_CREATE_VULNERABILITY_AUDIT_DETAILS_T Type 🔗
Details to create a vulnerability audit.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_create_vulnerability_audit_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
knowledge_base_id varchar2(32767),
compartment_id varchar2(32767),
application_dependencies dbms_cloud_oci_adm_application_dependency_tbl,
build_type varchar2(32767),
configuration dbms_cloud_oci_adm_vulnerability_audit_configuration_t,
usage_data dbms_cloud_oci_adm_usage_data_details_t,
display_name varchar2(32767),
source dbms_cloud_oci_adm_vulnerability_audit_source_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_vulnerability_audit_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_create_vulnerability_audit_details_t (
knowledge_base_id varchar2,
compartment_id varchar2,
application_dependencies dbms_cloud_oci_adm_application_dependency_tbl,
build_type varchar2,
configuration dbms_cloud_oci_adm_vulnerability_audit_configuration_t,
usage_data dbms_cloud_oci_adm_usage_data_details_t,
display_name varchar2,
source dbms_cloud_oci_adm_vulnerability_audit_source_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
knowledge_base_id
(required) The Oracle Cloud identifier (OCID) of the knowledge base.
compartment_id
(optional) The compartment Oracle Cloud identifier (OCID) of the vulnerability audit. If compartment identifier is not provided the compartment of the associated knowledge base will be used instead.
application_dependencies
(optional) List of application dependencies (without vulnerabilities).
build_type
(required) The type of the build tool.
configuration
(optional)
usage_data
(optional)
display_name
(optional) The name of the vulnerability audit.
source
(optional)
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_DETECT_STAGE_T Type 🔗
A detect stage performs a Vulnerability Audit and determines if the remediation run should proceed to remediation stage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_detect_stage_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_remediation_run_stage_t (
audit_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_detect_stage_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_detect_stage_t (
status varchar2,
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2,
summary varchar2,
remediation_run_id varchar2,
previous_stage_type varchar2,
next_stage_type varchar2,
audit_id varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_detect_stage_t is a subtype of the dbms_cloud_oci_adm_remediation_run_stage_t type.
Fields
Field
Description
audit_id
(optional) The Oracle Cloud identifier (OCID) of the vulnerability audit.
DBMS_CLOUD_OCI_ADM_ERROR_T Type 🔗
Error Information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
code
(required) A short error code that defines the error, meant for programmatic parsing.
message
(required) A human-readable error string.
DBMS_CLOUD_OCI_ADM_EXTERNAL_RESOURCE_VULNERABILITY_AUDIT_SOURCE_T Type 🔗
External source for the vulnerability audit.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_external_resource_vulnerability_audit_source_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_vulnerability_audit_source_t (
description varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_external_resource_vulnerability_audit_source_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_external_resource_vulnerability_audit_source_t (
l_type varchar2,
description varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_external_resource_vulnerability_audit_source_t is a subtype of the dbms_cloud_oci_adm_vulnerability_audit_source_t type.
Fields
Field
Description
description
(optional) Description of the external resource source.
DBMS_CLOUD_OCI_ADM_EXTERNAL_SCM_CONFIGURATION_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_external_scm_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_scm_configuration_t (
external_scm_type varchar2(32767),
repository_url varchar2(32767),
username varchar2(32767),
pat_secret_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_external_scm_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_external_scm_configuration_t (
scm_type varchar2,
branch varchar2,
build_file_location varchar2,
is_automerge_enabled number,
external_scm_type varchar2,
repository_url varchar2,
username varchar2,
pat_secret_id varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_external_scm_configuration_t is a subtype of the dbms_cloud_oci_adm_scm_configuration_t type.
Fields
Field
Description
external_scm_type
(required) The type of External Source Code Management.
Allowed values are: 'GITHUB', 'GITLAB'
repository_url
(required) The repository URL for the SCM. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName] For GitLab the expected format is https://gitlab.com/[groupName]/[repoName]
username
(optional) The username for the SCM (to perform operations such as cloning or pushing via HTTP).
pat_secret_id
(required) The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The secret provides the credentials necessary to authenticate against the SCM.
DBMS_CLOUD_OCI_ADM_GIT_HUB_ACTIONS_CONFIGURATION_T Type 🔗
Extends a Verify configuration with appropriate data to reach and use the build service provided by a GitHub Action.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_git_hub_actions_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_verify_configuration_t (
repository_url varchar2(32767),
pat_secret_id varchar2(32767),
username varchar2(32767),
workflow_name varchar2(32767),
additional_parameters json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_git_hub_actions_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_git_hub_actions_configuration_t (
build_service_type varchar2,
repository_url varchar2,
pat_secret_id varchar2,
username varchar2,
workflow_name varchar2,
additional_parameters json_element_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_git_hub_actions_configuration_t is a subtype of the dbms_cloud_oci_adm_verify_configuration_t type.
Fields
Field
Description
repository_url
(required) The location of the repository where the GitHub Actions is defined. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName]
pat_secret_id
(required) The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the GitHub Action.
username
(required) The username that will trigger the GitHub Action.
workflow_name
(required) The name of the GitHub Actions workflow that defines the build pipeline.
additional_parameters
(optional) Additional key-value pairs passed as parameters to the build service when running an experiment.
DBMS_CLOUD_OCI_ADM_GIT_LAB_PIPELINE_CONFIGURATION_T Type 🔗
Extends a Verify configuration with appropriate data to reach and use the build service provided by a GitLab Pipeline.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_git_lab_pipeline_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_verify_configuration_t (
repository_url varchar2(32767),
username varchar2(32767),
pat_secret_id varchar2(32767),
trigger_secret_id varchar2(32767),
additional_parameters json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_git_lab_pipeline_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_git_lab_pipeline_configuration_t (
build_service_type varchar2,
repository_url varchar2,
username varchar2,
pat_secret_id varchar2,
trigger_secret_id varchar2,
additional_parameters json_element_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_git_lab_pipeline_configuration_t is a subtype of the dbms_cloud_oci_adm_verify_configuration_t type.
Fields
Field
Description
repository_url
(required) The location of the Repository where the GitLab Pipeline will be run. The expected format is https://gitlab.com/[groupName]/[repoName]
username
(required) The username that will trigger the GitLab Pipeline.
pat_secret_id
(required) The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the GitLab pipeline.
trigger_secret_id
(required) The Oracle Cloud Identifier (OCID) of the trigger Secret. The Secret provides access to the trigger for a GitLab pipeline.
additional_parameters
(optional) Additional key-value pairs passed as parameters to the build service when running an experiment.
DBMS_CLOUD_OCI_ADM_JENKINS_PIPELINE_CONFIGURATION_T Type 🔗
Extends a Verify configuration with appropriate data to reach and use the build service provided by a Jenkins Pipeline.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_jenkins_pipeline_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_verify_configuration_t (
username varchar2(32767),
pat_secret_id varchar2(32767),
jenkins_url varchar2(32767),
job_name varchar2(32767),
additional_parameters json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_jenkins_pipeline_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_jenkins_pipeline_configuration_t (
build_service_type varchar2,
username varchar2,
pat_secret_id varchar2,
jenkins_url varchar2,
job_name varchar2,
additional_parameters json_element_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_jenkins_pipeline_configuration_t is a subtype of the dbms_cloud_oci_adm_verify_configuration_t type.
Fields
Field
Description
username
(required) The username that will be used to authenticate with Jenkins.
pat_secret_id
(required) The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.
jenkins_url
(required) The URL that locates the Jenkins pipeline.
job_name
(required) The name of the Jenkins pipeline job that identifies the build pipeline.
additional_parameters
(optional) Additional key-value pairs passed as parameters to the build service when running an experiment.
DBMS_CLOUD_OCI_ADM_KNOWLEDGE_BASE_T Type 🔗
A knowledge base is a component of Application Dependency Management (ADM) service that provides access to vulnerabilities.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_knowledge_base_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
compartment_id varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_knowledge_base_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_knowledge_base_t (
id varchar2,
display_name varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
compartment_id varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud Identifier (OCID) of the knowledge base.
display_name
(required) The name of the knowledge base.
time_created
(required) The creation date and time of the knowledge base (formatted according to RFC3339).
time_updated
(required) The date and time the knowledge base was last updated (formatted according to RFC3339).
lifecycle_state
(required) The current lifecycle state of the knowledge base.
(required) The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
freeform_tags
(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_KNOWLEDGE_BASE_SUMMARY_T Type 🔗
The summary of a knowledge base.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_knowledge_base_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_knowledge_base_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_knowledge_base_summary_t (
id varchar2,
display_name varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
compartment_id varchar2,
lifecycle_state varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud Identifier (OCID) of the knowledge base.
display_name
(required) The name of the knowledge base.
time_created
(required) The creation date and time of the knowledge base (formatted according to RFC3339).
time_updated
(required) The date and time the knowledge base was last updated (formatted according to RFC3339).
compartment_id
(required) The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
lifecycle_state
(required) The current lifecycle state of the knowledge base.
freeform_tags
(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_KNOWLEDGE_BASE_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_knowledge_base_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_knowledge_base_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_knowledge_base_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_KNOWLEDGE_BASE_COLLECTION_T Type 🔗
Collection of knowledge base summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_knowledge_base_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_knowledge_base_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_knowledge_base_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_knowledge_base_collection_t (
items dbms_cloud_oci_adm_knowledge_base_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of knowledge base summaries.
DBMS_CLOUD_OCI_ADM_NONE_VERIFY_CONFIGURATION_T Type 🔗
Empty verify configuration when no build was selected.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_none_verify_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_verify_configuration_t (
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_none_verify_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_none_verify_configuration_t (
build_service_type varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_none_verify_configuration_t is a subtype of the dbms_cloud_oci_adm_verify_configuration_t type.
DBMS_CLOUD_OCI_ADM_OCI_CODE_REPOSITORY_CONFIGURATION_T Type 🔗
An OCI Code repository configuration extends a SCM Configuration with necessary data to reach and use the OCI DevOps Code Repository.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_oci_code_repository_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_scm_configuration_t (
oci_code_repository_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_oci_code_repository_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_oci_code_repository_configuration_t (
scm_type varchar2,
branch varchar2,
build_file_location varchar2,
is_automerge_enabled number,
oci_code_repository_id varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_oci_code_repository_configuration_t is a subtype of the dbms_cloud_oci_adm_scm_configuration_t type.
Fields
Field
Description
oci_code_repository_id
(required) The Oracle Cloud Identifier (OCID) of the OCI DevOps repository.
DBMS_CLOUD_OCI_ADM_OCI_DEV_OPS_BUILD_CONFIGURATION_T Type 🔗
OCI DevOps configuration extends a Verify Configuration with necessary data to reach and use the OCI DevOps Build Service.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_oci_dev_ops_build_configuration_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_verify_configuration_t (
pipeline_id varchar2(32767),
additional_parameters json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_oci_dev_ops_build_configuration_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_oci_dev_ops_build_configuration_t (
build_service_type varchar2,
pipeline_id varchar2,
additional_parameters json_element_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_oci_dev_ops_build_configuration_t is a subtype of the dbms_cloud_oci_adm_verify_configuration_t type.
Fields
Field
Description
pipeline_id
(required) The Oracle Cloud Identifier (OCID) of the user's DevOps Build Pipeline.
additional_parameters
(optional) Additional key-value pairs passed as parameters to the build service when running an experiment.
DBMS_CLOUD_OCI_ADM_OCI_RESOURCE_VULNERABILITY_AUDIT_SOURCE_T Type 🔗
OCI resource source for the vulnerability audit.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_oci_resource_vulnerability_audit_source_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_vulnerability_audit_source_t (
oci_resource_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_oci_resource_vulnerability_audit_source_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_oci_resource_vulnerability_audit_source_t (
l_type varchar2,
oci_resource_id varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_oci_resource_vulnerability_audit_source_t is a subtype of the dbms_cloud_oci_adm_vulnerability_audit_source_t type.
Fields
Field
Description
oci_resource_id
(required) The Oracle Cloud identifier (OCID) of the OCI resource that triggered the vulnerability audit.
DBMS_CLOUD_OCI_ADM_RECOMMEND_STAGE_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_recommend_stage_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_remediation_run_stage_t (
recommended_updates_count number,
pull_request_properties dbms_cloud_oci_adm_pull_request_properties_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_recommend_stage_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_recommend_stage_t (
status varchar2,
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2,
summary varchar2,
remediation_run_id varchar2,
previous_stage_type varchar2,
next_stage_type varchar2,
recommended_updates_count number,
pull_request_properties dbms_cloud_oci_adm_pull_request_properties_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_recommend_stage_t is a subtype of the dbms_cloud_oci_adm_remediation_run_stage_t type.
Fields
Field
Description
recommended_updates_count
(optional) Count of recommended application dependencies to update.
pull_request_properties
(optional)
DBMS_CLOUD_OCI_ADM_REMEDIATION_RECIPE_T Type 🔗
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).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_recipe_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
compartment_id varchar2(32767),
knowledge_base_id varchar2(32767),
is_run_triggered_on_kb_change number,
scm_configuration dbms_cloud_oci_adm_scm_configuration_t,
verify_configuration dbms_cloud_oci_adm_verify_configuration_t,
detect_configuration dbms_cloud_oci_adm_detect_configuration_t,
network_configuration dbms_cloud_oci_adm_network_configuration_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_recipe_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_recipe_t (
id varchar2,
display_name varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
compartment_id varchar2,
knowledge_base_id varchar2,
is_run_triggered_on_kb_change number,
scm_configuration dbms_cloud_oci_adm_scm_configuration_t,
verify_configuration dbms_cloud_oci_adm_verify_configuration_t,
detect_configuration dbms_cloud_oci_adm_detect_configuration_t,
network_configuration dbms_cloud_oci_adm_network_configuration_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud Identifier (OCID) of the remediation recipe.
display_name
(required) The name of the Remediation Recipe.
time_created
(required) The creation date and time of the Remediation Recipe (formatted according to RFC3339).
time_updated
(required) The date and time the Remediation Recipe was last updated (formatted according to RFC3339).
lifecycle_state
(required) The current lifecycle state of the Remediation Recipe.
(required) The compartment Oracle Cloud Identifier (OCID) of the remediation recipe.
knowledge_base_id
(required) The Oracle Cloud Identifier (OCID) of the knowledge base.
is_run_triggered_on_kb_change
(required) Boolean indicating if a run should be automatically triggered once the Knowledge Base contents are updated.
scm_configuration
(required)
verify_configuration
(required)
detect_configuration
(required)
network_configuration
(required)
freeform_tags
(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_REMEDIATION_RECIPE_SUMMARY_T Type 🔗
The summary of a Remediation Recipe.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_recipe_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
knowledge_base_id varchar2(32767),
is_run_triggered_on_kb_change number,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_recipe_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_recipe_summary_t (
id varchar2,
display_name varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
compartment_id varchar2,
lifecycle_state varchar2,
knowledge_base_id varchar2,
is_run_triggered_on_kb_change number,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud Identifier (OCID) of the remediation recipe.
display_name
(required) The name of the Remediation Recipe.
time_created
(required) The creation date and time of the Remediation Recipe (formatted according to RFC3339).
time_updated
(required) The date and time the Remediation Recipe was last updated (formatted according to RFC3339).
compartment_id
(required) The compartment Oracle Cloud Identifier (OCID) of the remediation recipe.
lifecycle_state
(required) The current lifecycle state of the Remediation Recipe.
knowledge_base_id
(required) The Oracle Cloud Identifier (OCID) of the knowledge base.
is_run_triggered_on_kb_change
(required) Boolean indicating if a run should be automatically triggered once the Knowledge Base is updated.
freeform_tags
(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_REMEDIATION_RECIPE_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_remediation_recipe_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_recipe_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_remediation_recipe_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_REMEDIATION_RECIPE_COLLECTION_T Type 🔗
Collection of remediation recipe summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_recipe_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_remediation_recipe_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_recipe_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_recipe_collection_t (
items dbms_cloud_oci_adm_remediation_recipe_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of remediation recipe summaries.
DBMS_CLOUD_OCI_ADM_STAGE_SUMMARY_T Type 🔗
stage summary of a remediation run. A stage is one step of a remediation run.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_stage_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2(32767),
summary varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_stage_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_stage_summary_t (
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2,
summary varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
time_created
(required) The creation date and time of the stage (formatted according to RFC3339).
time_started
(optional) The date and time of the start of the stage (formatted according to RFC3339).
time_finished
(optional) The date and time of the finish of the stage (formatted according to RFC3339).
(optional) Information about the current step within the given stage.
DBMS_CLOUD_OCI_ADM_STAGE_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_stage_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_stage_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_stage_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
stages dbms_cloud_oci_adm_stage_summary_tbl,
remediation_recipe_id varchar2(32767),
remediation_run_source varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
current_stage_type varchar2(32767),
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_t (
id varchar2,
display_name varchar2,
stages dbms_cloud_oci_adm_stage_summary_tbl,
remediation_recipe_id varchar2,
remediation_run_source varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
current_stage_type varchar2,
compartment_id varchar2,
lifecycle_state varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud Identifier (OCID) of the remediation run.
display_name
(optional) The name of the remediation run.
stages
(optional) The list of remediation run stage summaries.
remediation_recipe_id
(required) The Oracle Cloud Identifier (OCID) of the Remediation Recipe.
remediation_run_source
(required) The source that triggered the Remediation Recipe.
Allowed values are: 'MANUAL', 'KNOWLEDGE_BASE'
time_created
(required) The creation date and time of the remediation run (formatted according to RFC3339).
time_updated
(required) The date and time the remediation run was last updated (formatted according to RFC3339).
time_started
(optional) The date and time of the start of the remediation run (formatted according to RFC3339).
time_finished
(optional) The date and time of the finish of the remediation run (formatted according to RFC3339).
current_stage_type
(optional) The type of the current stage of the remediation run.
(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_SUMMARY_T Type 🔗
remediation run summary.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
remediation_recipe_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
current_stage_type varchar2(32767),
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
remediation_run_source varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_summary_t (
id varchar2,
display_name varchar2,
remediation_recipe_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
current_stage_type varchar2,
compartment_id varchar2,
lifecycle_state varchar2,
remediation_run_source varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud identifier (OCID) of the remediation run.
display_name
(optional) The name of the remediation run.
remediation_recipe_id
(required) The Oracle Cloud identifier (OCID) of the Remediation Recipe.
time_created
(required) The creation date and time of the remediation run (formatted according to RFC3339).
time_updated
(required) The date and time the remediation run was last updated (formatted according to RFC3339).
time_started
(optional) The date and time of the start of the remediation run (formatted according to RFC3339).
time_finished
(optional) The date and time of the finish of the remediation run (formatted according to RFC3339).
current_stage_type
(optional) The type of the current stage of the remediation run.
(required) The compartment Oracle Cloud Identifier (OCID) of the remediation run.
lifecycle_state
(required) The current lifecycle state of the remediation run.
remediation_run_source
(required) The source from which the remediation run was triggered.
freeform_tags
(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_remediation_run_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_remediation_run_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_COLLECTION_T Type 🔗
Collection of remediation run summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_remediation_run_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_collection_t (
items dbms_cloud_oci_adm_remediation_run_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of remediation run summaries.
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_STAGE_SUMMARY_T Type 🔗
The summary of a remediation run stages.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_stage_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
status varchar2(32767),
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2(32767),
summary varchar2(32767),
remediation_run_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_stage_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_stage_summary_t (
status varchar2,
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2,
summary varchar2,
remediation_run_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
status
(required) The current status of remediation run stage.
time_created
(required) The creation date and time of the remediation run stage (formatted according to RFC3339).
time_started
(optional) The date and time of the start of the remediation run stage (formatted according to RFC3339).
time_finished
(optional) The date and time of the finish of the remediation run stage (formatted according to RFC3339).
(optional) Information about the current step within the stage.
remediation_run_id
(required) The Oracle Cloud identifier (OCID) of the remediation run.
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_STAGE_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_remediation_run_stage_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_stage_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_remediation_run_stage_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_REMEDIATION_RUN_STAGE_COLLECTION_T Type 🔗
Collection of remediation run stage summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_remediation_run_stage_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_remediation_run_stage_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_stage_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_remediation_run_stage_collection_t (
items dbms_cloud_oci_adm_remediation_run_stage_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of remediation run stage summaries.
DBMS_CLOUD_OCI_ADM_UNKNOWN_SOURCE_VULNERABILITY_AUDIT_SOURCE_T Type 🔗
Unknown source for vulnerability audit.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_unknown_source_vulnerability_audit_source_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_vulnerability_audit_source_t (
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_unknown_source_vulnerability_audit_source_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_unknown_source_vulnerability_audit_source_t (
l_type varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_unknown_source_vulnerability_audit_source_t is a subtype of the dbms_cloud_oci_adm_vulnerability_audit_source_t type.
DBMS_CLOUD_OCI_ADM_UPDATE_KNOWLEDGE_BASE_DETAILS_T Type 🔗
Details to update an existing knowledge base.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_update_knowledge_base_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_knowledge_base_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_knowledge_base_details_t (
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
display_name
(optional) The name of the knowledge base.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_UPDATE_REMEDIATION_RECIPE_DETAILS_T Type 🔗
Details to update an existing remediation recipe.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_update_remediation_recipe_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
scm_configuration dbms_cloud_oci_adm_scm_configuration_t,
verify_configuration dbms_cloud_oci_adm_verify_configuration_t,
detect_configuration dbms_cloud_oci_adm_detect_configuration_t,
network_configuration dbms_cloud_oci_adm_network_configuration_t,
knowledge_base_id varchar2(32767),
is_run_triggered_on_kb_change number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_remediation_recipe_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_remediation_recipe_details_t (
display_name varchar2,
scm_configuration dbms_cloud_oci_adm_scm_configuration_t,
verify_configuration dbms_cloud_oci_adm_verify_configuration_t,
detect_configuration dbms_cloud_oci_adm_detect_configuration_t,
network_configuration dbms_cloud_oci_adm_network_configuration_t,
knowledge_base_id varchar2,
is_run_triggered_on_kb_change number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
display_name
(optional) The name of the remediation recipe.
scm_configuration
(optional)
verify_configuration
(optional)
detect_configuration
(optional)
network_configuration
(optional)
knowledge_base_id
(optional) The Oracle Cloud Identifier (OCID) of the knowledge base.
is_run_triggered_on_kb_change
(optional) Boolean indicating if a run should be automatically triggered once the knowledge base is updated.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_UPDATE_REMEDIATION_RUN_DETAILS_T Type 🔗
Details to update an existing remediation run.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_update_remediation_run_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_remediation_run_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_remediation_run_details_t (
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
display_name
(optional) The name of the remediation run.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_UPDATE_VULNERABILITY_AUDIT_DETAILS_T Type 🔗
Details to update a vulnerability audit.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_update_vulnerability_audit_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_vulnerability_audit_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_update_vulnerability_audit_details_t (
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
display_name
(optional) The name of the vulnerability audit.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
DBMS_CLOUD_OCI_ADM_USAGE_DATA_VIA_OBJECT_STORAGE_TUPLE_DETAILS_T Type 🔗
Reference to an object in Object Storage as a tuple.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_usage_data_via_object_storage_tuple_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_usage_data_details_t (
bucket_name varchar2(32767),
namespace_name varchar2(32767),
object_name varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_usage_data_via_object_storage_tuple_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_usage_data_via_object_storage_tuple_details_t (
source_type varchar2,
bucket_name varchar2,
namespace_name varchar2,
object_name varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_usage_data_via_object_storage_tuple_details_t is a subtype of the dbms_cloud_oci_adm_usage_data_details_t type.
Fields
Field
Description
bucket_name
(required) The Object Storage bucket to read the usage data from.
namespace_name
(required) The Object Storage namespace to read the usage data from.
object_name
(required) The Object Storage object name to read the usage data from.
DBMS_CLOUD_OCI_ADM_VERIFY_STAGE_T Type 🔗
A verify stage will run a build pipeline in a branch.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_verify_stage_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_adm_remediation_run_stage_t (
pull_request_properties dbms_cloud_oci_adm_pull_request_properties_t,
pipeline_properties dbms_cloud_oci_adm_pipeline_properties_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_verify_stage_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_verify_stage_t (
status varchar2,
time_created timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
l_type varchar2,
summary varchar2,
remediation_run_id varchar2,
previous_stage_type varchar2,
next_stage_type varchar2,
pull_request_properties dbms_cloud_oci_adm_pull_request_properties_t,
pipeline_properties dbms_cloud_oci_adm_pipeline_properties_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_adm_verify_stage_t is a subtype of the dbms_cloud_oci_adm_remediation_run_stage_t type.
Fields
Field
Description
pull_request_properties
(optional)
pipeline_properties
(optional)
DBMS_CLOUD_OCI_ADM_VULNERABILITY_AUDIT_T Type 🔗
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.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_audit_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
knowledge_base_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
vulnerabilities dbms_cloud_oci_adm_vulnerability_tbl,
max_observed_cvss_v2_score number,
max_observed_cvss_v3_score number,
max_observed_cvss_v2_score_with_ignored number,
max_observed_cvss_v3_score_with_ignored number,
vulnerable_artifacts_count_with_ignored number,
vulnerable_artifacts_count number,
configuration dbms_cloud_oci_adm_vulnerability_audit_configuration_t,
usage_data dbms_cloud_oci_adm_usage_data_details_t,
is_success number,
build_type varchar2(32767),
source dbms_cloud_oci_adm_vulnerability_audit_source_t,
compartment_id varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_t (
id varchar2,
display_name varchar2,
knowledge_base_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
vulnerabilities dbms_cloud_oci_adm_vulnerability_tbl,
max_observed_cvss_v2_score number,
max_observed_cvss_v3_score number,
max_observed_cvss_v2_score_with_ignored number,
max_observed_cvss_v3_score_with_ignored number,
vulnerable_artifacts_count_with_ignored number,
vulnerable_artifacts_count number,
configuration dbms_cloud_oci_adm_vulnerability_audit_configuration_t,
usage_data dbms_cloud_oci_adm_usage_data_details_t,
is_success number,
build_type varchar2,
source dbms_cloud_oci_adm_vulnerability_audit_source_t,
compartment_id varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud identifier (OCID) of the vulnerability audit.
display_name
(optional) The name of the vulnerability audit.
knowledge_base_id
(required) The Oracle Cloud identifier (OCID) of the knowledge base.
time_created
(required) The creation date and time of the vulnerability audit (formatted according to RFC3339).
time_updated
(required) The update date and time of the vulnerability audit (formatted according to RFC3339).
lifecycle_state
(required) The current lifecycle state of the vulnerability audit.
(required) List of vulnerabilities found in the vulnerability audit.
max_observed_cvss_v2_score
(required) Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies.
max_observed_cvss_v3_score
(required) Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies.
max_observed_cvss_v2_score_with_ignored
(required) Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones.
max_observed_cvss_v3_score_with_ignored
(required) Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones.
vulnerable_artifacts_count_with_ignored
(required) Count of all vulnerable application dependencies.
vulnerable_artifacts_count
(required) Count of non-ignored vulnerable application dependencies.
configuration
(optional)
usage_data
(optional)
is_success
(optional) Indicates if an audit succeeded according to the configuration. The value is `null` if the audit is in the `CREATING` state.
build_type
(required) The type of the build tool.
Allowed values are: 'MAVEN'
source
(required)
compartment_id
(required) The compartment Oracle Cloud identifier (OCID) of the vulnerability audit.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_VULNERABILITY_AUDIT_SUMMARY_T Type 🔗
vulnerability audit summary.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_audit_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
knowledge_base_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
max_observed_cvss_v2_score number,
max_observed_cvss_v3_score number,
vulnerable_artifacts_count number,
max_observed_cvss_v2_score_with_ignored number,
max_observed_cvss_v3_score_with_ignored number,
vulnerable_artifacts_count_with_ignored number,
is_success number,
build_type varchar2(32767),
compartment_id varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_summary_t (
id varchar2,
display_name varchar2,
knowledge_base_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
max_observed_cvss_v2_score number,
max_observed_cvss_v3_score number,
vulnerable_artifacts_count number,
max_observed_cvss_v2_score_with_ignored number,
max_observed_cvss_v3_score_with_ignored number,
vulnerable_artifacts_count_with_ignored number,
is_success number,
build_type varchar2,
compartment_id varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
id
(required) The Oracle Cloud identifier (OCID) of the vulnerability audit.
display_name
(optional) The name of the vulnerability audit.
knowledge_base_id
(required) The Oracle Cloud identifier (OCID) of the knowledge base.
time_created
(required) The creation date and time of the vulnerability audit (formatted according to RFC3339).
time_updated
(required) The update date and time of the vulnerability audit (formatted according to RFC3339).
lifecycle_state
(required) The current lifecycle state of the vulnerability audit.
max_observed_cvss_v2_score
(required) Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies.
max_observed_cvss_v3_score
(required) Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies.
vulnerable_artifacts_count
(required) Count of non-ignored vulnerable application dependencies.
max_observed_cvss_v2_score_with_ignored
(required) Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones.
max_observed_cvss_v3_score_with_ignored
(required) Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones.
vulnerable_artifacts_count_with_ignored
(required) Count of all vulnerable application dependencies.
is_success
(optional) Indicates if an audit succeeded according to the configuration. The value is `null` if the audit is in the `CREATING` state.
build_type
(optional) Type of the build tool.
compartment_id
(required) The compartment Oracle Cloud identifier (OCID) of the vulnerability audit.
freeform_tags
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_VULNERABILITY_AUDIT_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_vulnerability_audit_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_audit_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_vulnerability_audit_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_VULNERABILITY_AUDIT_COLLECTION_T Type 🔗
Collection of vulnerability audit summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_vulnerability_audit_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_vulnerability_audit_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_vulnerability_audit_collection_t (
items dbms_cloud_oci_adm_vulnerability_audit_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of vulnerability audit summaries.
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_RESOURCE_T Type 🔗
A resource created or operated on by a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
entity_type varchar2(32767),
action_type varchar2(32767),
identifier varchar2(32767),
entity_uri varchar2(32767),
metadata json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_resource_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_resource_t (
entity_type varchar2,
action_type varchar2,
identifier varchar2,
entity_uri varchar2,
metadata json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
entity_type
(required) The resource type the work request affects.
action_type
(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
(required) The identifier of the resource the work request affects.
entity_uri
(optional) The URI path that the user can do a GET on to access the resource metadata
metadata
(optional) Additional information that helps to explain the resource.
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_RESOURCE_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_work_request_resource_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_work_request_resource_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_T Type 🔗
A description of workrequest status
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_adm_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_adm_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used
resources
(required) The resources affected by this work request.
percent_complete
(required) Percentage of the request completed.
time_accepted
(required) The date and time the request was created, as described in RFC 3339, section 14.29.
time_started
(optional) The date and time the request was started, as described in RFC 3339, section 14.29.
time_finished
(optional) The date and time the object was finished, as described in RFC 3339.
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_ERROR_T Type 🔗
An error encountered while executing a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_error_t (
code varchar2,
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
code
(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
message
(required) A human readable description of the issue encountered.
l_timestamp
(required) The time the error occured. An RFC3339 formatted datetime string.
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_ERROR_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_work_request_error_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_work_request_error_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_ERROR_COLLECTION_T Type 🔗
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_work_request_error_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_error_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_error_collection_t (
items dbms_cloud_oci_adm_work_request_error_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of workRequestError objects.
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_LOG_ENTRY_T Type 🔗
A log message from the execution of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_log_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_log_entry_t (
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
message
(required) Human-readable log message.
l_timestamp
(required) The time the log message was written. An RFC3339 formatted datetime string
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_LOG_ENTRY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_work_request_log_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_work_request_log_entry_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type 🔗
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_work_request_log_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_log_entry_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_log_entry_collection_t (
items dbms_cloud_oci_adm_work_request_log_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field
Description
items
(required) List of workRequestLogEntries.
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_SUMMARY_T Type 🔗
A summary of the status of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_adm_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_summary_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_adm_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used
resources
(required) The resources affected by this work request.
percent_complete
(required) Percentage of the request completed.
time_accepted
(required) The date and time the request was created, as described in RFC 3339, section 14.29.
time_started
(optional) The date and time the request was started, as described in RFC 3339, section 14.29.
time_finished
(optional) The date and time the object was finished, as described in RFC 3339.
freeform_tags
(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`
defined_tags
(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
system_tags
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_SUMMARY_TBL Type 🔗
Nested table type of dbms_cloud_oci_adm_work_request_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_adm_work_request_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_ADM_WORK_REQUEST_SUMMARY_COLLECTION_T Type 🔗
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_adm_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_adm_work_request_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_summary_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_adm_work_request_summary_collection_t (
items dbms_cloud_oci_adm_work_request_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;