RemediationRun¶

class oci.adm.models.RemediationRun(**kwargs)¶

Bases: object

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.

Attributes

`CURRENT_STAGE_TYPE_APPLY`	A constant which can be used with the current_stage_type property of a RemediationRun.
`CURRENT_STAGE_TYPE_DETECT`	A constant which can be used with the current_stage_type property of a RemediationRun.
`CURRENT_STAGE_TYPE_RECOMMEND`	A constant which can be used with the current_stage_type property of a RemediationRun.
`CURRENT_STAGE_TYPE_VERIFY`	A constant which can be used with the current_stage_type property of a RemediationRun.
`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a RemediationRun.
`REMEDIATION_RUN_SOURCE_KNOWLEDGE_BASE`	A constant which can be used with the remediation_run_source property of a RemediationRun.
`REMEDIATION_RUN_SOURCE_MANUAL`	A constant which can be used with the remediation_run_source property of a RemediationRun.
`compartment_id`	[Required] Gets the compartment_id of this RemediationRun.
`current_stage_type`	Gets the current_stage_type of this RemediationRun.
`defined_tags`	[Required] Gets the defined_tags of this RemediationRun.
`display_name`	Gets the display_name of this RemediationRun.
`freeform_tags`	[Required] Gets the freeform_tags of this RemediationRun.
`id`	[Required] Gets the id of this RemediationRun.
`lifecycle_state`	[Required] Gets the lifecycle_state of this RemediationRun.
`remediation_recipe_id`	[Required] Gets the remediation_recipe_id of this RemediationRun.
`remediation_run_source`	[Required] Gets the remediation_run_source of this RemediationRun.
`stages`	Gets the stages of this RemediationRun.
`system_tags`	Gets the system_tags of this RemediationRun.
`time_created`	[Required] Gets the time_created of this RemediationRun.
`time_finished`	Gets the time_finished of this RemediationRun.
`time_started`	Gets the time_started of this RemediationRun.
`time_updated`	[Required] Gets the time_updated of this RemediationRun.

Methods

__init__(**kwargs) Initializes a new RemediationRun object with values from keyword arguments.

CURRENT_STAGE_TYPE_APPLY = 'APPLY'¶: A constant which can be used with the current_stage_type property of a RemediationRun. This constant has a value of “APPLY”

CURRENT_STAGE_TYPE_DETECT = 'DETECT'¶: A constant which can be used with the current_stage_type property of a RemediationRun. This constant has a value of “DETECT”

CURRENT_STAGE_TYPE_RECOMMEND = 'RECOMMEND'¶: A constant which can be used with the current_stage_type property of a RemediationRun. This constant has a value of “RECOMMEND”

CURRENT_STAGE_TYPE_VERIFY = 'VERIFY'¶: A constant which can be used with the current_stage_type property of a RemediationRun. This constant has a value of “VERIFY”

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “CANCELING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a RemediationRun. This constant has a value of “SUCCEEDED”

REMEDIATION_RUN_SOURCE_KNOWLEDGE_BASE = 'KNOWLEDGE_BASE'¶: A constant which can be used with the remediation_run_source property of a RemediationRun. This constant has a value of “KNOWLEDGE_BASE”

REMEDIATION_RUN_SOURCE_MANUAL = 'MANUAL'¶: A constant which can be used with the remediation_run_source property of a RemediationRun. This constant has a value of “MANUAL”

__init__(**kwargs)¶

Initializes a new RemediationRun object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this RemediationRun.
display_name (str) – The value to assign to the display_name property of this RemediationRun.
stages (list[oci.adm.models.StageSummary]) – The value to assign to the stages property of this RemediationRun.
remediation_recipe_id (str) – The value to assign to the remediation_recipe_id property of this RemediationRun.
remediation_run_source (str) – The value to assign to the remediation_run_source property of this RemediationRun. Allowed values for this property are: “MANUAL”, “KNOWLEDGE_BASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this RemediationRun.
time_updated (datetime) – The value to assign to the time_updated property of this RemediationRun.
time_started (datetime) – The value to assign to the time_started property of this RemediationRun.
time_finished (datetime) – The value to assign to the time_finished property of this RemediationRun.
current_stage_type (str) – The value to assign to the current_stage_type property of this RemediationRun. Allowed values for this property are: “DETECT”, “RECOMMEND”, “VERIFY”, “APPLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this RemediationRun.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RemediationRun. Allowed values for this property are: “ACCEPTED”, “CANCELED”, “CANCELING”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RemediationRun.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RemediationRun.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RemediationRun.

compartment_id¶

[Required] Gets the compartment_id of this RemediationRun. The compartment Oracle Cloud Identifier (OCID) of the remediation run.

Returns:	The compartment_id of this RemediationRun.
Return type:	str

current_stage_type¶

Gets the current_stage_type of this RemediationRun. The type of the current stage of the remediation run.

Allowed values for this property are: “DETECT”, “RECOMMEND”, “VERIFY”, “APPLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The current_stage_type of this RemediationRun.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this RemediationRun. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this RemediationRun.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this RemediationRun. The name of the remediation run.

Returns:	The display_name of this RemediationRun.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this RemediationRun. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this RemediationRun.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this RemediationRun. The Oracle Cloud Identifier (OCID) of the remediation run.

Returns:	The id of this RemediationRun.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this RemediationRun. The current lifecycle state of the remediation run.

Allowed values for this property are: “ACCEPTED”, “CANCELED”, “CANCELING”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this RemediationRun.
Return type:	str

remediation_recipe_id¶

[Required] Gets the remediation_recipe_id of this RemediationRun. The Oracle Cloud Identifier (OCID) of the Remediation Recipe.

Returns:	The remediation_recipe_id of this RemediationRun.
Return type:	str

remediation_run_source¶

[Required] Gets the remediation_run_source of this RemediationRun. The source that triggered the Remediation Recipe.

Allowed values for this property are: “MANUAL”, “KNOWLEDGE_BASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The remediation_run_source of this RemediationRun.
Return type:	str

stages¶

Gets the stages of this RemediationRun. The list of remediation run stage summaries.

Returns:	The stages of this RemediationRun.
Return type:	list[oci.adm.models.StageSummary]

system_tags¶

Gets the system_tags of this RemediationRun. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this RemediationRun.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this RemediationRun. The creation date and time of the remediation run (formatted according to RFC3339).

Returns:	The time_created of this RemediationRun.
Return type:	datetime

time_finished¶

Gets the time_finished of this RemediationRun. The date and time of the finish of the remediation run (formatted according to RFC3339).

Returns:	The time_finished of this RemediationRun.
Return type:	datetime

time_started¶

Gets the time_started of this RemediationRun. The date and time of the start of the remediation run (formatted according to RFC3339).

Returns:	The time_started of this RemediationRun.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this RemediationRun. The date and time the remediation run was last updated (formatted according to RFC3339).

Returns:	The time_updated of this RemediationRun.
Return type:	datetime