DetectStage

class oci.adm.models.DetectStage(**kwargs)

Bases: oci.adm.models.remediation_run_stage.RemediationRunStage

A detect stage performs a Vulnerability Audit and determines if the remediation run should proceed to remediation stage.

Attributes

NEXT_STAGE_TYPE_APPLY str(object=’’) -> str
NEXT_STAGE_TYPE_DETECT str(object=’’) -> str
NEXT_STAGE_TYPE_RECOMMEND str(object=’’) -> str
NEXT_STAGE_TYPE_VERIFY str(object=’’) -> str
PREVIOUS_STAGE_TYPE_APPLY str(object=’’) -> str
PREVIOUS_STAGE_TYPE_DETECT str(object=’’) -> str
PREVIOUS_STAGE_TYPE_RECOMMEND str(object=’’) -> str
PREVIOUS_STAGE_TYPE_VERIFY str(object=’’) -> str
STATUS_CANCELED str(object=’’) -> str
STATUS_CANCELING str(object=’’) -> str
STATUS_CREATED str(object=’’) -> str
STATUS_FAILED str(object=’’) -> str
STATUS_IN_PROGRESS str(object=’’) -> str
STATUS_SUCCEEDED str(object=’’) -> str
TYPE_APPLY str(object=’’) -> str
TYPE_DETECT str(object=’’) -> str
TYPE_RECOMMEND str(object=’’) -> str
TYPE_VERIFY str(object=’’) -> str
audit_id Gets the audit_id of this DetectStage.
next_stage_type Gets the next_stage_type of this RemediationRunStage.
previous_stage_type Gets the previous_stage_type of this RemediationRunStage.
remediation_run_id [Required] Gets the remediation_run_id of this RemediationRunStage.
status [Required] Gets the status of this RemediationRunStage.
summary Gets the summary of this RemediationRunStage.
time_created [Required] Gets the time_created of this RemediationRunStage.
time_finished Gets the time_finished of this RemediationRunStage.
time_started Gets the time_started of this RemediationRunStage.
type [Required] Gets the type of this RemediationRunStage.

Methods

__init__(**kwargs) Initializes a new DetectStage object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
NEXT_STAGE_TYPE_APPLY = 'APPLY'
NEXT_STAGE_TYPE_DETECT = 'DETECT'
NEXT_STAGE_TYPE_RECOMMEND = 'RECOMMEND'
NEXT_STAGE_TYPE_VERIFY = 'VERIFY'
PREVIOUS_STAGE_TYPE_APPLY = 'APPLY'
PREVIOUS_STAGE_TYPE_DETECT = 'DETECT'
PREVIOUS_STAGE_TYPE_RECOMMEND = 'RECOMMEND'
PREVIOUS_STAGE_TYPE_VERIFY = 'VERIFY'
STATUS_CANCELED = 'CANCELED'
STATUS_CANCELING = 'CANCELING'
STATUS_CREATED = 'CREATED'
STATUS_FAILED = 'FAILED'
STATUS_IN_PROGRESS = 'IN_PROGRESS'
STATUS_SUCCEEDED = 'SUCCEEDED'
TYPE_APPLY = 'APPLY'
TYPE_DETECT = 'DETECT'
TYPE_RECOMMEND = 'RECOMMEND'
TYPE_VERIFY = 'VERIFY'
__init__(**kwargs)

Initializes a new DetectStage object with values from keyword arguments. The default value of the type attribute of this class is DETECT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • status (str) – The value to assign to the status property of this DetectStage. Allowed values for this property are: “CREATED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “CANCELING”, “CANCELED”
  • time_created (datetime) – The value to assign to the time_created property of this DetectStage.
  • time_started (datetime) – The value to assign to the time_started property of this DetectStage.
  • time_finished (datetime) – The value to assign to the time_finished property of this DetectStage.
  • type (str) – The value to assign to the type property of this DetectStage. Allowed values for this property are: “DETECT”, “RECOMMEND”, “VERIFY”, “APPLY”
  • summary (str) – The value to assign to the summary property of this DetectStage.
  • remediation_run_id (str) – The value to assign to the remediation_run_id property of this DetectStage.
  • previous_stage_type (str) – The value to assign to the previous_stage_type property of this DetectStage. Allowed values for this property are: “DETECT”, “RECOMMEND”, “VERIFY”, “APPLY”
  • next_stage_type (str) – The value to assign to the next_stage_type property of this DetectStage. Allowed values for this property are: “DETECT”, “RECOMMEND”, “VERIFY”, “APPLY”
  • audit_id (str) – The value to assign to the audit_id property of this DetectStage.
audit_id

Gets the audit_id of this DetectStage. The Oracle Cloud identifier (OCID) of the vulnerability audit.

Returns:The audit_id of this DetectStage.
Return type:str
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

next_stage_type

Gets the next_stage_type of this RemediationRunStage. The next type of stage in 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 next_stage_type of this RemediationRunStage.
Return type:str
previous_stage_type

Gets the previous_stage_type of this RemediationRunStage. The previous type of stage in 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 previous_stage_type of this RemediationRunStage.
Return type:str
remediation_run_id

[Required] Gets the remediation_run_id of this RemediationRunStage. The Oracle Cloud identifier (OCID) of the remediation run.

Returns:The remediation_run_id of this RemediationRunStage.
Return type:str
status

[Required] Gets the status of this RemediationRunStage. The current status of a remediation run stage.

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

Returns:The status of this RemediationRunStage.
Return type:str
summary

Gets the summary of this RemediationRunStage. Information about the current step within the stage.

Returns:The summary of this RemediationRunStage.
Return type:str
time_created

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

Returns:The time_created of this RemediationRunStage.
Return type:datetime
time_finished

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

Returns:The time_finished of this RemediationRunStage.
Return type:datetime
time_started

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

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

[Required] Gets the type of this RemediationRunStage. The type of the remediation run stage.

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 type of this RemediationRunStage.
Return type:str